@@ -31,16 +31,17 @@ numbers (CR/2024/00001) instead of database IDs for all operations.
3131Key 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
4546Key Models
4647~~~~~~~~~~
@@ -73,26 +74,26 @@ To configure OAuth 2.0 clients with appropriate scopes:
7374 by ``spp_api_v2 ``)
74752. 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
8283API 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
9798Security
9899~~~~~~~~
@@ -105,12 +106,12 @@ enforces scope checks on each endpoint. Users must authenticate via the
105106Extension 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
115116UI Location
116117~~~~~~~~~~~
0 commit comments