Skip to content

Commit 5bcf96b

Browse files
emjay0921emjay0921
committed
chore: regenerate READMEs and remove duplicate .rst fragments
Remove .rst readme fragments that have .md duplicates (the hook cannot process both) and regenerate all auto-generated README.rst and index.html files to match the current oca-gen-addon-readme output.
1 parent 2a25b61 commit 5bcf96b

113 files changed

Lines changed: 1969 additions & 1868 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎spp_alerts/README.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ Key Capabilities
4343
Key Models
4444
~~~~~~~~~~
4545

46-
+--------------------+-------------------------------------------------+
47-
| Model | Description |
48-
+====================+=================================================+
49-
| ``spp.alert`` | Alert instance with state tracking and |
50-
| | resolution workflow |
51-
+--------------------+-------------------------------------------------+
52-
| ``spp.alert.rule`` | Rule configuration for monitoring criteria and |
53-
| | thresholds |
54-
+--------------------+-------------------------------------------------+
46+
+--------------------+------------------------------------------------+
47+
| Model | Description |
48+
+====================+================================================+
49+
| ``spp.alert`` | Alert instance with state tracking and |
50+
| | resolution workflow |
51+
+--------------------+------------------------------------------------+
52+
| ``spp.alert.rule`` | Rule configuration for monitoring criteria and |
53+
| | thresholds |
54+
+--------------------+------------------------------------------------+
5555

5656
Configuration
5757
~~~~~~~~~~~~~

‎spp_api_v2/README.rst‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,24 @@ Key Capabilities
4444
Key Models
4545
----------
4646

47-
+---------------------------+------------------------------------------+
48-
| Model | Description |
49-
+===========================+==========================================+
50-
| ``spp.api.client`` | OAuth 2.0 credentials, organization |
51-
| | verification |
52-
+---------------------------+------------------------------------------+
53-
| ``spp.api.client.scope`` | Resource/action permissions |
54-
+---------------------------+------------------------------------------+
55-
| ``spp.api.path`` | Endpoint configuration and filters |
56-
+---------------------------+------------------------------------------+
57-
| ``spp.api.path.filter`` | Field-level filter configurations |
58-
+---------------------------+------------------------------------------+
59-
| ``spp.api.filter.preset`` | Saved filter combinations |
60-
+---------------------------+------------------------------------------+
61-
| ``spp.api.extension`` | Domain field registry |
62-
+---------------------------+------------------------------------------+
63-
| ``spp.consent.scope`` | Resource types per consent |
64-
+---------------------------+------------------------------------------+
47+
+---------------------------+-----------------------------------------+
48+
| Model | Description |
49+
+===========================+=========================================+
50+
| ``spp.api.client`` | OAuth 2.0 credentials, organization |
51+
| | verification |
52+
+---------------------------+-----------------------------------------+
53+
| ``spp.api.client.scope`` | Resource/action permissions |
54+
+---------------------------+-----------------------------------------+
55+
| ``spp.api.path`` | Endpoint configuration and filters |
56+
+---------------------------+-----------------------------------------+
57+
| ``spp.api.path.filter`` | Field-level filter configurations |
58+
+---------------------------+-----------------------------------------+
59+
| ``spp.api.filter.preset`` | Saved filter combinations |
60+
+---------------------------+-----------------------------------------+
61+
| ``spp.api.extension`` | Domain field registry |
62+
+---------------------------+-----------------------------------------+
63+
| ``spp.consent.scope`` | Resource types per consent |
64+
+---------------------------+-----------------------------------------+
6565

6666
UI Location
6767
-----------
@@ -110,20 +110,20 @@ API endpoints available at ``/api/v2/`` (token endpoint:
110110
Security
111111
--------
112112

113-
+--------------------------+-------------------------------------------+
114-
| Group | Access |
115-
+==========================+===========================================+
116-
| ``group_api_v2_viewer`` | Read-only: all API configuration and |
117-
| | consent |
118-
+--------------------------+-------------------------------------------+
119-
| ``group_api_v2_officer`` | Read/Write: all models (no |
120-
| | create/delete), full CRUD on consent |
121-
| | scopes |
122-
+--------------------------+-------------------------------------------+
123-
| ``group_api_v2_manager`` | Full CRUD: clients, scopes, paths, |
124-
| | filters, presets, extensions; |
125-
| | Read/Write/Create on consent (no delete) |
126-
+--------------------------+-------------------------------------------+
113+
+--------------------------+------------------------------------------+
114+
| Group | Access |
115+
+==========================+==========================================+
116+
| ``group_api_v2_viewer`` | Read-only: all API configuration and |
117+
| | consent |
118+
+--------------------------+------------------------------------------+
119+
| ``group_api_v2_officer`` | Read/Write: all models (no |
120+
| | create/delete), full CRUD on consent |
121+
| | scopes |
122+
+--------------------------+------------------------------------------+
123+
| ``group_api_v2_manager`` | Full CRUD: clients, scopes, paths, |
124+
| | filters, presets, extensions; |
125+
| | Read/Write/Create on consent (no delete) |
126+
+--------------------------+------------------------------------------+
127127

128128
Extension Points
129129
----------------

‎spp_api_v2/static/description/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -393,8 +393,8 @@ <h1>Key Capabilities</h1>
393393
<h1>Key Models</h1>
394394
<table border="1" class="docutils">
395395
<colgroup>
396-
<col width="39%" />
397-
<col width="61%" />
396+
<col width="40%" />
397+
<col width="60%" />
398398
</colgroup>
399399
<thead valign="bottom">
400400
<tr><th class="head">Model</th>

‎spp_api_v2_change_request/README.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,19 @@ Key Models
4747

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

50-
+-----------------------------+----------------------------------------+
51-
| Model | Usage |
52-
+=============================+========================================+
53-
| ``fastapi.endpoint`` | Extended to register ChangeRequest |
54-
| | router with API V2 |
55-
+-----------------------------+----------------------------------------+
56-
| ``spp.change.request`` | CRUD operations via REST API |
57-
+-----------------------------+----------------------------------------+
58-
| ``spp.change.request.type`` | Looked up by code in create requests |
59-
+-----------------------------+----------------------------------------+
60-
| ``spp.registry.id`` | Used to resolve registrant identifiers |
61-
| | (system|value) |
62-
+-----------------------------+----------------------------------------+
50+
+-----------------------------+---------------------------------------+
51+
| Model | Usage |
52+
+=============================+=======================================+
53+
| ``fastapi.endpoint`` | Extended to register ChangeRequest |
54+
| | router with API V2 |
55+
+-----------------------------+---------------------------------------+
56+
| ``spp.change.request`` | CRUD operations via REST API |
57+
+-----------------------------+---------------------------------------+
58+
| ``spp.change.request.type`` | Looked up by code in create requests |
59+
+-----------------------------+---------------------------------------+
60+
| ``spp.registry.id`` | Used to resolve registrant |
61+
| | identifiers (system|value) |
62+
+-----------------------------+---------------------------------------+
6363

6464
Configuration
6565
~~~~~~~~~~~~~

‎spp_api_v2_change_request/static/description/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -395,8 +395,8 @@ <h1>Key Models</h1>
395395
<p>This module extends existing models and does not define new ones.</p>
396396
<table border="1" class="docutils">
397397
<colgroup>
398-
<col width="42%" />
399-
<col width="58%" />
398+
<col width="43%" />
399+
<col width="57%" />
400400
</colgroup>
401401
<thead valign="bottom">
402402
<tr><th class="head">Model</th>
@@ -415,8 +415,8 @@ <h1>Key Models</h1>
415415
<td>Looked up by code in create requests</td>
416416
</tr>
417417
<tr><td><tt class="docutils literal">spp.registry.id</tt></td>
418-
<td>Used to resolve registrant identifiers
419-
(system|value)</td>
418+
<td>Used to resolve registrant
419+
identifiers (system|value)</td>
420420
</tr>
421421
</tbody>
422422
</table>

‎spp_api_v2_entitlements/README.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ Key Capabilities
4444
Key Models
4545
~~~~~~~~~~
4646

47-
+--------------------------+-------------------------------------------+
48-
| Model | Description |
49-
+==========================+===========================================+
50-
| ``spp.api.client.scope`` | Extended to add ``entitlement`` as |
51-
| | resource type |
52-
+--------------------------+-------------------------------------------+
53-
| ``fastapi.endpoint`` | Extended to register entitlement router |
54-
| | for ``api_v2`` app |
55-
+--------------------------+-------------------------------------------+
47+
+--------------------------+------------------------------------------+
48+
| Model | Description |
49+
+==========================+==========================================+
50+
| ``spp.api.client.scope`` | Extended to add ``entitlement`` as |
51+
| | resource type |
52+
+--------------------------+------------------------------------------+
53+
| ``fastapi.endpoint`` | Extended to register entitlement router |
54+
| | for ``api_v2`` app |
55+
+--------------------------+------------------------------------------+
5656

5757
Configuration
5858
~~~~~~~~~~~~~

‎spp_api_v2_products/README.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ Key Models
4444

4545
This module extends existing models rather than introducing new ones:
4646

47-
+--------------------------+-------------------------------------------+
48-
| Model | Extension |
49-
+==========================+===========================================+
50-
| ``spp.api.client.scope`` | Adds "product" resource type for scope |
51-
| | management |
52-
+--------------------------+-------------------------------------------+
53-
| ``fastapi.endpoint`` | Registers Product, ProductCategory, UoM |
54-
| | routers |
55-
+--------------------------+-------------------------------------------+
47+
+--------------------------+------------------------------------------+
48+
| Model | Extension |
49+
+==========================+==========================================+
50+
| ``spp.api.client.scope`` | Adds "product" resource type for scope |
51+
| | management |
52+
+--------------------------+------------------------------------------+
53+
| ``fastapi.endpoint`` | Registers Product, ProductCategory, UoM |
54+
| | routers |
55+
+--------------------------+------------------------------------------+
5656

5757
Configuration
5858
~~~~~~~~~~~~~

‎spp_api_v2_service_points/README.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ Extended Models
4545

4646
This module extends existing models from dependencies:
4747

48-
+--------------------------+-------------------------------------------+
49-
| Model | Description |
50-
+==========================+===========================================+
51-
| ``spp.api.client.scope`` | Extended to add "service_point" resource |
52-
| | type for OAuth scopes |
53-
+--------------------------+-------------------------------------------+
54-
| ``fastapi.endpoint`` | Extended to register Service Point router |
55-
| | in API V2 app |
56-
+--------------------------+-------------------------------------------+
48+
+--------------------------+------------------------------------------+
49+
| Model | Description |
50+
+==========================+==========================================+
51+
| ``spp.api.client.scope`` | Extended to add "service_point" resource |
52+
| | type for OAuth scopes |
53+
+--------------------------+------------------------------------------+
54+
| ``fastapi.endpoint`` | Extended to register Service Point |
55+
| | router in API V2 app |
56+
+--------------------------+------------------------------------------+
5757

5858
Configuration
5959
~~~~~~~~~~~~~

‎spp_api_v2_service_points/static/description/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -407,8 +407,8 @@ <h1>Extended Models</h1>
407407
type for OAuth scopes</td>
408408
</tr>
409409
<tr><td><tt class="docutils literal">fastapi.endpoint</tt></td>
410-
<td>Extended to register Service Point router
411-
in API V2 app</td>
410+
<td>Extended to register Service Point
411+
router in API V2 app</td>
412412
</tr>
413413
</tbody>
414414
</table>

‎spp_api_v2_vocabulary/README.rst‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,20 @@ Key Capabilities
4545
Key Models
4646
~~~~~~~~~~
4747

48-
+--------------------------+-------------------------------------------+
49-
| Model | Description |
50-
+==========================+===========================================+
51-
| ``spp.vocabulary`` | Vocabulary definitions exposed via GET |
52-
| | endpoints |
53-
+--------------------------+-------------------------------------------+
54-
| ``spp.vocabulary.code`` | Individual codes within vocabularies |
55-
+--------------------------+-------------------------------------------+
56-
| ``spp.api.client.scope`` | Extended to add "vocabulary" resource |
57-
| | type for OAuth |
58-
+--------------------------+-------------------------------------------+
59-
| ``fastapi.endpoint`` | Extended to register Vocabulary router in |
60-
| | API V2 |
61-
+--------------------------+-------------------------------------------+
48+
+--------------------------+------------------------------------------+
49+
| Model | Description |
50+
+==========================+==========================================+
51+
| ``spp.vocabulary`` | Vocabulary definitions exposed via GET |
52+
| | endpoints |
53+
+--------------------------+------------------------------------------+
54+
| ``spp.vocabulary.code`` | Individual codes within vocabularies |
55+
+--------------------------+------------------------------------------+
56+
| ``spp.api.client.scope`` | Extended to add "vocabulary" resource |
57+
| | type for OAuth |
58+
+--------------------------+------------------------------------------+
59+
| ``fastapi.endpoint`` | Extended to register Vocabulary router |
60+
| | in API V2 |
61+
+--------------------------+------------------------------------------+
6262

6363
API Endpoints
6464
~~~~~~~~~~~~~

0 commit comments

Comments
 (0)