Skip to content

Commit cd5312f

Browse files
committed
chore: regenerate all README.rst and index.html to match CI (Linux/Python 3.11)
1 parent a3e647b commit cd5312f

148 files changed

Lines changed: 2584 additions & 2530 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.

endpoint_route_handler/README.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -114,31 +114,31 @@ You can see a real life example on shopfloor.app model.
114114
Known issues / Roadmap
115115
======================
116116

117-
- add api docs helpers
117+
- add api docs helpers
118118

119-
- allow multiple HTTP methods on the same endpoint
119+
- allow multiple HTTP methods on the same endpoint
120120

121-
- multiple values for route and methods
121+
- multiple values for route and methods
122122

123-
keep the same in the ui for now, later own we can imagine a
124-
multi-value selection or just add text field w/ proper validation
125-
and cleanup
123+
keep the same in the ui for now, later own we can imagine a
124+
multi-value selection or just add text field w/ proper validation
125+
and cleanup
126126

127-
remove the route field in the table of endpoint_route
127+
remove the route field in the table of endpoint_route
128128

129-
support a comma separated list of routes maybe support comma
130-
separated list of methods use only routing.routes for generating
131-
the rule sort and freeze its values to update the endpoint hash
129+
support a comma separated list of routes maybe support comma
130+
separated list of methods use only routing.routes for generating
131+
the rule sort and freeze its values to update the endpoint hash
132132

133-
catch dup route exception on the sync to detect duplicated routes
134-
and use the endpoint_hash to retrieve the real record (note: we
135-
could store more info in the routing information which will stay in
136-
the map)
133+
catch dup route exception on the sync to detect duplicated routes
134+
and use the endpoint_hash to retrieve the real record (note: we
135+
could store more info in the routing information which will stay
136+
in the map)
137137

138-
for customizing the rule behavior the endpoint the hook is to
139-
override the registry lookup
138+
for customizing the rule behavior the endpoint the hook is to
139+
override the registry lookup
140140

141-
make EndpointRule class overridable on the registry
141+
make EndpointRule class overridable on the registry
142142

143143
NOTE in v16 we won't care anymore about odoo controller so the lookup of
144144
the controller can be simplified to a basic py obj that holds the
@@ -165,8 +165,8 @@ Authors
165165
Contributors
166166
------------
167167

168-
- Simone Orsi <simone.orsi@camptocamp.com>
169-
- Nguyen Minh Chien <chien@trobz.com>
168+
- Simone Orsi <simone.orsi@camptocamp.com>
169+
- Nguyen Minh Chien <chien@trobz.com>
170170

171171
Maintainers
172172
-----------

endpoint_route_handler/static/description/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,8 +476,8 @@ <h1><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h1>
476476
the rule sort and freeze its values to update the endpoint hash</p>
477477
<p>catch dup route exception on the sync to detect duplicated routes
478478
and use the endpoint_hash to retrieve the real record (note: we
479-
could store more info in the routing information which will stay in
480-
the map)</p>
479+
could store more info in the routing information which will stay
480+
in the map)</p>
481481
<p>for customizing the rule behavior the endpoint the hook is to
482482
override the registry lookup</p>
483483
<p>make EndpointRule class overridable on the registry</p>

spp_alerts/README.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ domain-specific conditions.
3131
Key Capabilities
3232
~~~~~~~~~~~~~~~~
3333

34-
- Track alert lifecycle through state machine: active → acknowledged →
35-
resolved
36-
- Record resolution details including user, timestamp, and notes
37-
- Classify alerts by type using ``spp.vocabulary`` codes (threshold,
38-
expiry, deadline, manual, system)
39-
- Prioritize alerts as low, medium, high, or critical
40-
- Send mail notifications via ``mail.thread`` integration
41-
- Auto-generate alert references in ALR-YYYY-NNNNN format
34+
- Track alert lifecycle through state machine: active → acknowledged →
35+
resolved
36+
- Record resolution details including user, timestamp, and notes
37+
- Classify alerts by type using ``spp.vocabulary`` codes (threshold,
38+
expiry, deadline, manual, system)
39+
- Prioritize alerts as low, medium, high, or critical
40+
- Send mail notifications via ``mail.thread`` integration
41+
- Auto-generate alert references in ALR-YYYY-NNNNN format
4242

4343
Key Models
4444
~~~~~~~~~~
@@ -67,9 +67,9 @@ After installing:
6767
UI Location
6868
~~~~~~~~~~~
6969

70-
- **Menu**: Settings > Technical > Alerts > Alerts
71-
- **Configuration**: Settings > Technical > Alerts > Alert Rules
72-
- **Form Tabs**: Details, Resolution (alerts); Thresholds (rules)
70+
- **Menu**: Settings > Technical > Alerts > Alerts
71+
- **Configuration**: Settings > Technical > Alerts > Alert Rules
72+
- **Form Tabs**: Details, Resolution (alerts); Thresholds (rules)
7373

7474
Security
7575
~~~~~~~~
@@ -85,14 +85,14 @@ Group Access
8585
Extension Points
8686
~~~~~~~~~~~~~~~~
8787

88-
- Inherit ``spp.alert`` to add domain-specific fields (e.g., stock
89-
levels, document references)
90-
- Inherit ``spp.alert.rule`` to add custom threshold or evaluation
91-
criteria
92-
- Override ``action_acknowledge()`` or ``action_resolve()`` to add
93-
custom workflow steps
94-
- Consumer modules implement alert checking via cron jobs or event
95-
handlers that evaluate rules and call ``create()`` on ``spp.alert``
88+
- Inherit ``spp.alert`` to add domain-specific fields (e.g., stock
89+
levels, document references)
90+
- Inherit ``spp.alert.rule`` to add custom threshold or evaluation
91+
criteria
92+
- Override ``action_acknowledge()`` or ``action_resolve()`` to add
93+
custom workflow steps
94+
- Consumer modules implement alert checking via cron jobs or event
95+
handlers that evaluate rules and call ``create()`` on ``spp.alert``
9696

9797
Dependencies
9898
~~~~~~~~~~~~

spp_api_v2/README.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ all identifiers use namespace URIs for global interoperability.
3030
Key Capabilities
3131
----------------
3232

33-
- **OAuth 2.0 Authentication**: Client credentials flow with
34-
scrypt-hashed secrets, scoped access
35-
- **Consent-Based Access Control**: All reads require active consent,
36-
filtered by organization type
37-
- **External Identifiers Only**: Namespace URIs for lookups, vocabulary
38-
IDs for coded values
39-
- **Source Tracking**: Records data provenance per ADR-008
40-
- **Extension Registry**: Domain modules register custom fields via
41-
``spp.api.extension``
42-
- **Batch Operations**: Create/update multiple registrants per request
33+
- **OAuth 2.0 Authentication**: Client credentials flow with
34+
scrypt-hashed secrets, scoped access
35+
- **Consent-Based Access Control**: All reads require active consent,
36+
filtered by organization type
37+
- **External Identifiers Only**: Namespace URIs for lookups, vocabulary
38+
IDs for coded values
39+
- **Source Tracking**: Records data provenance per ADR-008
40+
- **Extension Registry**: Domain modules register custom fields via
41+
``spp.api.extension``
42+
- **Batch Operations**: Create/update multiple registrants per request
4343

4444
Key Models
4545
----------
@@ -69,29 +69,29 @@ UI Location
6969
Navigate to **Registry > Configuration > API V2** for all API
7070
configuration. Available submenus:
7171

72-
- **API Clients** - Manage OAuth credentials and organization
73-
verification
74-
- **API Extensions** - View registered custom field extensions
75-
- **API Paths** - Configure available endpoints and static filters
76-
- **API Filters** - Define queryable field filters per path
77-
- **Filter Presets** - Create named filter combinations
72+
- **API Clients** - Manage OAuth credentials and organization
73+
verification
74+
- **API Extensions** - View registered custom field extensions
75+
- **API Paths** - Configure available endpoints and static filters
76+
- **API Filters** - Define queryable field filters per path
77+
- **Filter Presets** - Create named filter combinations
7878

7979
**API Client Form Tabs:**
8080

81-
- **Consent & Security** - Consent requirements, legal basis,
82-
organization type verification
83-
- **Scopes** - Resource/action permissions and program restrictions
84-
- **Description** - Client documentation
81+
- **Consent & Security** - Consent requirements, legal basis,
82+
organization type verification
83+
- **Scopes** - Resource/action permissions and program restrictions
84+
- **Description** - Client documentation
8585

8686
**API Extension Form Tabs:**
8787

88-
- **Fields** - Registered custom fields from domain modules
89-
- **JSON Schema** - Auto-generated schema for extension fields
88+
- **Fields** - Registered custom fields from domain modules
89+
- **JSON Schema** - Auto-generated schema for extension fields
9090

9191
**API Path Form Tabs:**
9292

93-
- **Filters** - Field-level filter configurations (inline editable)
94-
- **Presets** - Saved filter combinations (inline editable)
93+
- **Filters** - Field-level filter configurations (inline editable)
94+
- **Presets** - Saved filter combinations (inline editable)
9595

9696
Configuration
9797
-------------
@@ -128,9 +128,9 @@ Security
128128
Extension Points
129129
----------------
130130

131-
- Inherit ``spp.api.extension`` to register custom fields
132-
- Override ``_get_fastapi_routers()`` in ``fastapi.endpoint`` for custom
133-
endpoints
131+
- Inherit ``spp.api.extension`` to register custom fields
132+
- Override ``_get_fastapi_routers()`` in ``fastapi.endpoint`` for
133+
custom endpoints
134134

135135
Dependencies
136136
------------

spp_api_v2/static/description/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,8 +504,8 @@ <h1>Security</h1>
504504
<h1>Extension Points</h1>
505505
<ul class="simple">
506506
<li>Inherit <tt class="docutils literal">spp.api.extension</tt> to register custom fields</li>
507-
<li>Override <tt class="docutils literal">_get_fastapi_routers()</tt> in <tt class="docutils literal">fastapi.endpoint</tt> for custom
508-
endpoints</li>
507+
<li>Override <tt class="docutils literal">_get_fastapi_routers()</tt> in <tt class="docutils literal">fastapi.endpoint</tt> for
508+
custom endpoints</li>
509509
</ul>
510510
</div>
511511
<div class="section" id="dependencies">

spp_api_v2_change_request/README.rst

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,17 @@ numbers (CR/2024/00001) instead of database IDs for all operations.
3131
Key Capabilities
3232
~~~~~~~~~~~~~~~~
3333

34-
- Create change requests in draft status with registrant and detail data
35-
- Read individual change requests by reference or search with filters
36-
(registrant, type, status, dates)
37-
- Update detail data on draft change requests with optimistic locking
38-
via If-Match headers
39-
- Submit draft requests for approval workflow
40-
- Approve, reject, or request revision on pending requests (requires
41-
approval scope)
42-
- Apply approved change requests to registrant records
43-
- Reset rejected/revision requests to draft for resubmission
34+
- Create change requests in draft status with registrant and detail
35+
data
36+
- Read individual change requests by reference or search with filters
37+
(registrant, type, status, dates)
38+
- Update detail data on draft change requests with optimistic locking
39+
via If-Match headers
40+
- Submit draft requests for approval workflow
41+
- Approve, reject, or request revision on pending requests (requires
42+
approval scope)
43+
- Apply approved change requests to registrant records
44+
- Reset rejected/revision requests to draft for resubmission
4445

4546
Key Models
4647
~~~~~~~~~~
@@ -73,26 +74,26 @@ To configure OAuth 2.0 clients with appropriate scopes:
7374
by ``spp_api_v2``)
7475
2. Configure OAuth 2.0 clients with appropriate scopes:
7576

76-
- ``change_request:read`` - Read and search change requests
77-
- ``change_request:create`` - Create new change requests
78-
- ``change_request:update`` - Update, submit, and reset requests
79-
- ``change_request:approve`` - Approve, reject, or request revision
80-
- ``change_request:apply`` - Apply approved changes to registrants
77+
- ``change_request:read`` - Read and search change requests
78+
- ``change_request:create`` - Create new change requests
79+
- ``change_request:update`` - Update, submit, and reset requests
80+
- ``change_request:approve`` - Approve, reject, or request revision
81+
- ``change_request:apply`` - Apply approved changes to registrants
8182

8283
API Endpoints
8384
~~~~~~~~~~~~~
8485

85-
- ``POST /ChangeRequest`` - Create new change request
86-
- ``GET /ChangeRequest/{reference}`` - Read by reference
87-
- ``GET /ChangeRequest`` - Search with filters
88-
- ``PUT /ChangeRequest/{reference}`` - Update detail data
89-
- ``POST /ChangeRequest/{reference}/$submit`` - Submit for approval
90-
- ``POST /ChangeRequest/{reference}/$approve`` - Approve request
91-
- ``POST /ChangeRequest/{reference}/$reject`` - Reject request
92-
- ``POST /ChangeRequest/{reference}/$request-revision`` - Request
93-
revision
94-
- ``POST /ChangeRequest/{reference}/$apply`` - Apply to registrant
95-
- ``POST /ChangeRequest/{reference}/$reset`` - Reset to draft
86+
- ``POST /ChangeRequest`` - Create new change request
87+
- ``GET /ChangeRequest/{reference}`` - Read by reference
88+
- ``GET /ChangeRequest`` - Search with filters
89+
- ``PUT /ChangeRequest/{reference}`` - Update detail data
90+
- ``POST /ChangeRequest/{reference}/$submit`` - Submit for approval
91+
- ``POST /ChangeRequest/{reference}/$approve`` - Approve request
92+
- ``POST /ChangeRequest/{reference}/$reject`` - Reject request
93+
- ``POST /ChangeRequest/{reference}/$request-revision`` - Request
94+
revision
95+
- ``POST /ChangeRequest/{reference}/$apply`` - Apply to registrant
96+
- ``POST /ChangeRequest/{reference}/$reset`` - Reset to draft
9697

9798
Security
9899
~~~~~~~~
@@ -105,12 +106,12 @@ enforces scope checks on each endpoint. Users must authenticate via the
105106
Extension Points
106107
~~~~~~~~~~~~~~~~
107108

108-
- Inherit ``ChangeRequestService`` to customize serialization,
109-
validation, or business logic
110-
- Override router endpoint functions to add custom validation or side
111-
effects
112-
- Extend the API schema by inheriting the Pydantic models in
113-
``schemas/change_request.py``
109+
- Inherit ``ChangeRequestService`` to customize serialization,
110+
validation, or business logic
111+
- Override router endpoint functions to add custom validation or side
112+
effects
113+
- Extend the API schema by inheriting the Pydantic models in
114+
``schemas/change_request.py``
114115

115116
UI Location
116117
~~~~~~~~~~~

spp_api_v2_change_request/static/description/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,8 @@ <h1 class="title">OpenSPP API V2 - Change Request</h1>
378378
<div class="section" id="key-capabilities">
379379
<h1>Key Capabilities</h1>
380380
<ul class="simple">
381-
<li>Create change requests in draft status with registrant and detail data</li>
381+
<li>Create change requests in draft status with registrant and detail
382+
data</li>
382383
<li>Read individual change requests by reference or search with filters
383384
(registrant, type, status, dates)</li>
384385
<li>Update detail data on draft change requests with optimistic locking

spp_api_v2_cycles/README.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ and requires OAuth 2.0 authentication with resource-based scopes.
3030
Key Capabilities
3131
~~~~~~~~~~~~~~~~
3232

33-
- **Read Cycle**: Retrieve cycle details by name via
34-
``GET /Cycle/{identifier}``
35-
- **Search Cycles**: Filter cycles by program, state, start/end dates,
36-
or last updated timestamp
37-
- **Pagination**: Support for offset-based pagination with configurable
38-
page size (max 100)
39-
- **Statistics**: Expose beneficiary count, entitlement count, payment
40-
count, and total amounts
41-
- **Cycle Navigation**: Reference to previous and next cycles in
42-
sequence
43-
- **OAuth Scopes**: Extend API client scopes with ``cycle`` resource
44-
type for read operations
33+
- **Read Cycle**: Retrieve cycle details by name via
34+
``GET /Cycle/{identifier}``
35+
- **Search Cycles**: Filter cycles by program, state, start/end dates,
36+
or last updated timestamp
37+
- **Pagination**: Support for offset-based pagination with configurable
38+
page size (max 100)
39+
- **Statistics**: Expose beneficiary count, entitlement count, payment
40+
count, and total amounts
41+
- **Cycle Navigation**: Reference to previous and next cycles in
42+
sequence
43+
- **OAuth Scopes**: Extend API client scopes with ``cycle`` resource
44+
type for read operations
4545

4646
Key Models
4747
~~~~~~~~~~
@@ -70,8 +70,8 @@ UI Location
7070

7171
No standalone menu. API endpoints are available at:
7272

73-
- ``/api/v2/spp/Cycle`` - Search cycles
74-
- ``/api/v2/spp/Cycle/{identifier}`` - Read cycle by name
73+
- ``/api/v2/spp/Cycle`` - Search cycles
74+
- ``/api/v2/spp/Cycle/{identifier}`` - Read cycle by name
7575

7676
Security
7777
~~~~~~~~
@@ -87,12 +87,12 @@ existing models.
8787
Extension Points
8888
~~~~~~~~~~~~~~~~
8989

90-
- Override ``CycleService.to_api_schema()`` to add custom fields to the
91-
API response
92-
- Inherit ``Cycle`` schema to add domain-specific attributes in the
93-
``extension`` field
94-
- Add search filters by extending ``CycleService.search()`` to support
95-
additional query parameters
90+
- Override ``CycleService.to_api_schema()`` to add custom fields to the
91+
API response
92+
- Inherit ``Cycle`` schema to add domain-specific attributes in the
93+
``extension`` field
94+
- Add search filters by extending ``CycleService.search()`` to support
95+
additional query parameters
9696

9797
Dependencies
9898
~~~~~~~~~~~~

0 commit comments

Comments
 (0)