Skip to content

fix(spp_security,spp_hazard): rename Hazard & Emergency to fix XML parse error #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
emjay0921 wants to merge 4 commits into from
Closed

fix(spp_security,spp_hazard): rename Hazard & Emergency to fix XML parse error #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea996f4
fix(spp_security,spp_hazard): rename Hazard & Emergency to avoid XML …
emjay0921 Mar 12, 2026
d61502b
chore: regenerate README.rst and index.html with Python 3.11 to match CI
emjay0921 Mar 12, 2026
be3716b
Revert "chore: regenerate README.rst and index.html with Python 3.11 …
emjay0921 Mar 12, 2026
081bbfc
chore: regenerate spp_security and spp_hazard READMEs with Python 3.11
emjay0921 Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions spp_alerts/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ Key Capabilities
Key Models
~~~~~~~~~~

+--------------------+-------------------------------------------------+
| Model | Description |
+====================+=================================================+
| ``spp.alert`` | Alert instance with state tracking and |
| | resolution workflow |
+--------------------+-------------------------------------------------+
| ``spp.alert.rule`` | Rule configuration for monitoring criteria and |
| | thresholds |
+--------------------+-------------------------------------------------+
+--------------------+------------------------------------------------+
| Model | Description |
+====================+================================================+
| ``spp.alert`` | Alert instance with state tracking and |
| | resolution workflow |
+--------------------+------------------------------------------------+
| ``spp.alert.rule`` | Rule configuration for monitoring criteria and |
| | thresholds |
+--------------------+------------------------------------------------+

Configuration
~~~~~~~~~~~~~
Expand Down
64 changes: 32 additions & 32 deletions spp_api_v2/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,24 @@ Key Capabilities
Key Models
----------

+---------------------------+------------------------------------------+
| Model | Description |
+===========================+==========================================+
| ``spp.api.client`` | OAuth 2.0 credentials, organization |
| | verification |
+---------------------------+------------------------------------------+
| ``spp.api.client.scope`` | Resource/action permissions |
+---------------------------+------------------------------------------+
| ``spp.api.path`` | Endpoint configuration and filters |
+---------------------------+------------------------------------------+
| ``spp.api.path.filter`` | Field-level filter configurations |
+---------------------------+------------------------------------------+
| ``spp.api.filter.preset`` | Saved filter combinations |
+---------------------------+------------------------------------------+
| ``spp.api.extension`` | Domain field registry |
+---------------------------+------------------------------------------+
| ``spp.consent.scope`` | Resource types per consent |
+---------------------------+------------------------------------------+
+---------------------------+-----------------------------------------+
| Model | Description |
+===========================+=========================================+
| ``spp.api.client`` | OAuth 2.0 credentials, organization |
| | verification |
+---------------------------+-----------------------------------------+
| ``spp.api.client.scope`` | Resource/action permissions |
+---------------------------+-----------------------------------------+
| ``spp.api.path`` | Endpoint configuration and filters |
+---------------------------+-----------------------------------------+
| ``spp.api.path.filter`` | Field-level filter configurations |
+---------------------------+-----------------------------------------+
| ``spp.api.filter.preset`` | Saved filter combinations |
+---------------------------+-----------------------------------------+
| ``spp.api.extension`` | Domain field registry |
+---------------------------+-----------------------------------------+
| ``spp.consent.scope`` | Resource types per consent |
+---------------------------+-----------------------------------------+

UI Location
-----------
Expand Down Expand Up @@ -110,20 +110,20 @@ API endpoints available at ``/api/v2/`` (token endpoint:
Security
--------

+--------------------------+-------------------------------------------+
| Group | Access |
+==========================+===========================================+
| ``group_api_v2_viewer`` | Read-only: all API configuration and |
| | consent |
+--------------------------+-------------------------------------------+
| ``group_api_v2_officer`` | Read/Write: all models (no |
| | create/delete), full CRUD on consent |
| | scopes |
+--------------------------+-------------------------------------------+
| ``group_api_v2_manager`` | Full CRUD: clients, scopes, paths, |
| | filters, presets, extensions; |
| | Read/Write/Create on consent (no delete) |
+--------------------------+-------------------------------------------+
+--------------------------+------------------------------------------+
| Group | Access |
+==========================+==========================================+
| ``group_api_v2_viewer`` | Read-only: all API configuration and |
| | consent |
+--------------------------+------------------------------------------+
| ``group_api_v2_officer`` | Read/Write: all models (no |
| | create/delete), full CRUD on consent |
| | scopes |
+--------------------------+------------------------------------------+
| ``group_api_v2_manager`` | Full CRUD: clients, scopes, paths, |
| | filters, presets, extensions; |
| | Read/Write/Create on consent (no delete) |
+--------------------------+------------------------------------------+

Extension Points
----------------
Expand Down
4 changes: 2 additions & 2 deletions spp_api_v2/static/description/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,8 +393,8 @@ <h1>Key Capabilities</h1>
<h1>Key Models</h1>
<table border="1" class="docutils">
<colgroup>
<col width="39%" />
<col width="61%" />
<col width="40%" />
<col width="60%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Model</th>
Expand Down
26 changes: 13 additions & 13 deletions spp_api_v2_change_request/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,19 @@ Key Models

This module extends existing models and does not define new ones.

+-----------------------------+----------------------------------------+
| Model | Usage |
+=============================+========================================+
| ``fastapi.endpoint`` | Extended to register ChangeRequest |
| | router with API V2 |
+-----------------------------+----------------------------------------+
| ``spp.change.request`` | CRUD operations via REST API |
+-----------------------------+----------------------------------------+
| ``spp.change.request.type`` | Looked up by code in create requests |
+-----------------------------+----------------------------------------+
| ``spp.registry.id`` | Used to resolve registrant identifiers |
| | (system|value) |
+-----------------------------+----------------------------------------+
+-----------------------------+---------------------------------------+
| Model | Usage |
+=============================+=======================================+
| ``fastapi.endpoint`` | Extended to register ChangeRequest |
| | router with API V2 |
+-----------------------------+---------------------------------------+
| ``spp.change.request`` | CRUD operations via REST API |
+-----------------------------+---------------------------------------+
| ``spp.change.request.type`` | Looked up by code in create requests |
+-----------------------------+---------------------------------------+
| ``spp.registry.id`` | Used to resolve registrant |
| | identifiers (system|value) |
+-----------------------------+---------------------------------------+

Configuration
~~~~~~~~~~~~~
Expand Down
8 changes: 4 additions & 4 deletions spp_api_v2_change_request/static/description/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,8 +395,8 @@ <h1>Key Models</h1>
<p>This module extends existing models and does not define new ones.</p>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
<col width="43%" />
<col width="57%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Model</th>
Expand All @@ -415,8 +415,8 @@ <h1>Key Models</h1>
<td>Looked up by code in create requests</td>
</tr>
<tr><td><tt class="docutils literal">spp.registry.id</tt></td>
<td>Used to resolve registrant identifiers
(system|value)</td>
<td>Used to resolve registrant
identifiers (system|value)</td>
</tr>
</tbody>
</table>
Expand Down
18 changes: 9 additions & 9 deletions spp_api_v2_entitlements/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ Key Capabilities
Key Models
~~~~~~~~~~

+--------------------------+-------------------------------------------+
| Model | Description |
+==========================+===========================================+
| ``spp.api.client.scope`` | Extended to add ``entitlement`` as |
| | resource type |
+--------------------------+-------------------------------------------+
| ``fastapi.endpoint`` | Extended to register entitlement router |
| | for ``api_v2`` app |
+--------------------------+-------------------------------------------+
+--------------------------+------------------------------------------+
| Model | Description |
+==========================+==========================================+
| ``spp.api.client.scope`` | Extended to add ``entitlement`` as |
| | resource type |
+--------------------------+------------------------------------------+
| ``fastapi.endpoint`` | Extended to register entitlement router |
| | for ``api_v2`` app |
+--------------------------+------------------------------------------+

Configuration
~~~~~~~~~~~~~
Expand Down
57 changes: 31 additions & 26 deletions spp_api_v2_gis/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,27 @@ API Endpoints

**OGC API - Features (primary interface)**

+-------------------------------------------+--------+------------------------------+
| Endpoint | Method | Description |
+===========================================+========+==============================+
| ``/gis/ogc/`` | GET | OGC API landing page |
+-------------------------------------------+--------+------------------------------+
| ``/gis/ogc/conformance`` | GET | OGC conformance classes |
+-------------------------------------------+--------+------------------------------+
| ``/gis/ogc/collections`` | GET | List feature collections |
+-------------------------------------------+--------+------------------------------+
| ``/gis/ogc/collections/{id}`` | GET | Collection metadata |
+-------------------------------------------+--------+------------------------------+
| ``/gis/ogc/collections/{id}/items`` | GET | Feature items (GeoJSON) |
+-------------------------------------------+--------+------------------------------+
| ``/gis/ogc/collections/{id}/items/{fid}`` | GET | Single feature |
+-------------------------------------------+--------+------------------------------+
| ``/gis/ogc/collections/{id}/qml`` | GET | QGIS style file (extension) |
+-------------------------------------------+--------+------------------------------+
+-----------------------------+--------+-----------------------------+
| Endpoint | Method | Description |
+=============================+========+=============================+
| ``/gis/ogc/`` | GET | OGC API landing page |
+-----------------------------+--------+-----------------------------+
| ``/gis/ogc/conformance`` | GET | OGC conformance classes |
+-----------------------------+--------+-----------------------------+
| ``/gis/ogc/collections`` | GET | List feature collections |
+-----------------------------+--------+-----------------------------+
| `` | GET | Collection metadata |
| /gis/ogc/collections/{id}`` | | |
+-----------------------------+--------+-----------------------------+
| ``/gis/o | GET | Feature items (GeoJSON) |
| gc/collections/{id}/items`` | | |
+-----------------------------+--------+-----------------------------+
| ``/gis/ogc/col | GET | Single feature |
| lections/{id}/items/{fid}`` | | |
+-----------------------------+--------+-----------------------------+
| ``/gis | GET | QGIS style file (extension) |
| /ogc/collections/{id}/qml`` | | |
+-----------------------------+--------+-----------------------------+

**Additional endpoints**

Expand All @@ -87,15 +91,16 @@ Scopes and Data Privacy

**OAuth Scopes**

+------------------+--------------+------------------------------------+
| Scope | Access | Description |
+==================+==============+====================================+
| ``gis:read`` | Read-only | View collections, layers, |
| | | statistics, export data |
+------------------+--------------+------------------------------------+
| ``gis:geofence`` | Read + Write | Create and archive geofences (also |
| | | requires ``gis:read`` for listing) |
+------------------+--------------+------------------------------------+
+------------------+--------------+----------------------------------+
| Scope | Access | Description |
+==================+==============+==================================+
| ``gis:read`` | Read-only | View collections, layers, |
| | | statistics, export data |
+------------------+--------------+----------------------------------+
| ``gis:geofence`` | Read + Write | Create and archive geofences |
| | | (also requires ``gis:read`` for |
| | | listing) |
+------------------+--------------+----------------------------------+

**What data is exposed**

Expand Down
27 changes: 16 additions & 11 deletions spp_api_v2_gis/static/description/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,9 +401,9 @@ <h1>API Endpoints</h1>
<p><strong>OGC API - Features (primary interface)</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="53%" />
<col width="10%" />
<col width="37%" />
<col width="44%" />
<col width="12%" />
<col width="44%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Endpoint</th>
Expand All @@ -424,19 +424,23 @@ <h1>API Endpoints</h1>
<td>GET</td>
<td>List feature collections</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">/gis/ogc/collections/{id}</span></tt></td>
<tr><td>``
/gis/ogc/collections/{id}``</td>
<td>GET</td>
<td>Collection metadata</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">/gis/ogc/collections/{id}/items</span></tt></td>
<tr><td><tt class="docutils literal">/gis/o
<span class="pre">gc/collections/{id}/items</span></tt></td>
<td>GET</td>
<td>Feature items (GeoJSON)</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">/gis/ogc/collections/{id}/items/{fid}</span></tt></td>
<tr><td><tt class="docutils literal">/gis/ogc/col
<span class="pre">lections/{id}/items/{fid}</span></tt></td>
<td>GET</td>
<td>Single feature</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">/gis/ogc/collections/{id}/qml</span></tt></td>
<tr><td><tt class="docutils literal">/gis
<span class="pre">/ogc/collections/{id}/qml</span></tt></td>
<td>GET</td>
<td>QGIS style file (extension)</td>
</tr>
Expand Down Expand Up @@ -480,9 +484,9 @@ <h1>Scopes and Data Privacy</h1>
<p><strong>OAuth Scopes</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="26%" />
<col width="27%" />
<col width="21%" />
<col width="53%" />
<col width="52%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Scope</th>
Expand All @@ -498,8 +502,9 @@ <h1>Scopes and Data Privacy</h1>
</tr>
<tr><td><tt class="docutils literal">gis:geofence</tt></td>
<td>Read + Write</td>
<td>Create and archive geofences (also
requires <tt class="docutils literal">gis:read</tt> for listing)</td>
<td>Create and archive geofences
(also requires <tt class="docutils literal">gis:read</tt> for
listing)</td>
</tr>
</tbody>
</table>
Expand Down
18 changes: 9 additions & 9 deletions spp_api_v2_products/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ Key Models

This module extends existing models rather than introducing new ones:

+--------------------------+-------------------------------------------+
| Model | Extension |
+==========================+===========================================+
| ``spp.api.client.scope`` | Adds "product" resource type for scope |
| | management |
+--------------------------+-------------------------------------------+
| ``fastapi.endpoint`` | Registers Product, ProductCategory, UoM |
| | routers |
+--------------------------+-------------------------------------------+
+--------------------------+------------------------------------------+
| Model | Extension |
+==========================+==========================================+
| ``spp.api.client.scope`` | Adds "product" resource type for scope |
| | management |
+--------------------------+------------------------------------------+
| ``fastapi.endpoint`` | Registers Product, ProductCategory, UoM |
| | routers |
+--------------------------+------------------------------------------+

Configuration
~~~~~~~~~~~~~
Expand Down
18 changes: 9 additions & 9 deletions spp_api_v2_service_points/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ Extended Models

This module extends existing models from dependencies:

+--------------------------+-------------------------------------------+
| Model | Description |
+==========================+===========================================+
| ``spp.api.client.scope`` | Extended to add "service_point" resource |
| | type for OAuth scopes |
+--------------------------+-------------------------------------------+
| ``fastapi.endpoint`` | Extended to register Service Point router |
| | in API V2 app |
+--------------------------+-------------------------------------------+
+--------------------------+------------------------------------------+
| Model | Description |
+==========================+==========================================+
| ``spp.api.client.scope`` | Extended to add "service_point" resource |
| | type for OAuth scopes |
+--------------------------+------------------------------------------+
| ``fastapi.endpoint`` | Extended to register Service Point |
| | router in API V2 app |
+--------------------------+------------------------------------------+

Configuration
~~~~~~~~~~~~~
Expand Down
Loading
Loading