-
Notifications
You must be signed in to change notification settings - Fork 2
feat(BCH-1106): local-definitions routes for POAM #315
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10634,6 +10634,227 @@ const docTemplate = `{ | |||||
| } | ||||||
| } | ||||||
| } | ||||||
| }, | ||||||
| "post": { | ||||||
| "description": "Creates local definitions for a given POA\u0026M.", | ||||||
| "consumes": [ | ||||||
| "application/json" | ||||||
| ], | ||||||
| "produces": [ | ||||||
| "application/json" | ||||||
| ], | ||||||
| "tags": [ | ||||||
| "Plan Of Action and Milestones" | ||||||
| ], | ||||||
| "summary": "Create local definitions for a POA\u0026M", | ||||||
| "parameters": [ | ||||||
| { | ||||||
| "type": "string", | ||||||
| "description": "POA\u0026M ID", | ||||||
| "name": "id", | ||||||
| "in": "path", | ||||||
| "required": true | ||||||
| }, | ||||||
| { | ||||||
| "description": "Local definitions data", | ||||||
| "name": "localDefinitions", | ||||||
| "in": "body", | ||||||
| "required": true, | ||||||
| "schema": { | ||||||
| "$ref": "#/definitions/oscalTypes_1_1_3.PlanOfActionAndMilestonesLocalDefinitions" | ||||||
| } | ||||||
| } | ||||||
| ], | ||||||
| "responses": { | ||||||
| "201": { | ||||||
| "description": "Created", | ||||||
| "schema": { | ||||||
| "$ref": "#/definitions/handler.GenericDataResponse-oscalTypes_1_1_3_PlanOfActionAndMilestonesLocalDefinitions" | ||||||
| } | ||||||
| }, | ||||||
| "400": { | ||||||
| "description": "Bad Request", | ||||||
| "schema": { | ||||||
| "$ref": "#/definitions/api.Error" | ||||||
| } | ||||||
| }, | ||||||
| "404": { | ||||||
| "description": "Not Found", | ||||||
| "schema": { | ||||||
| "$ref": "#/definitions/api.Error" | ||||||
| } | ||||||
| }, | ||||||
| "500": { | ||||||
| "description": "Internal Server Error", | ||||||
| "schema": { | ||||||
| "$ref": "#/definitions/api.Error" | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| }, | ||||||
| "/oscal/plan-of-action-and-milestones/{id}/local-definitions/{definitionId}": { | ||||||
| "get": { | ||||||
| "description": "Retrieves local definitions for a given POA\u0026M (same as GET /local-definitions but with consistent routing).", | ||||||
| "produces": [ | ||||||
| "application/json" | ||||||
| ], | ||||||
| "tags": [ | ||||||
| "Plan Of Action and Milestones" | ||||||
| ], | ||||||
| "summary": "Get local definitions for a POA\u0026M", | ||||||
| "parameters": [ | ||||||
| { | ||||||
| "type": "string", | ||||||
| "description": "POA\u0026M ID", | ||||||
| "name": "id", | ||||||
| "in": "path", | ||||||
| "required": true | ||||||
| }, | ||||||
| { | ||||||
| "type": "string", | ||||||
| "description": "Definition ID (placeholder for consistency, not used in implementation)", | ||||||
|
||||||
| "description": "Definition ID (placeholder for consistency, not used in implementation)", | |
| "description": "Definition ID for the specific local definition", |
Copilot
AI
Jan 24, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Misleading parameter description: The documentation states "Definition ID (placeholder for consistency, not used in implementation)" but the definitionId parameter is actually used in the implementation to identify which specific local definition to retrieve, update, or delete. This description should be updated to accurately reflect that the parameter is actively used.
| "description": "Definition ID (placeholder for consistency, not used in implementation)", | |
| "description": "Definition ID used to identify the local definition to update", |
Copilot
AI
Jan 24, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Misleading parameter description: The documentation states "Definition ID (placeholder for consistency, not used in implementation)" but the definitionId parameter is actually used in the implementation to identify which specific local definition to retrieve, update, or delete. This description should be updated to accurately reflect that the parameter is actively used.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inaccurate endpoint description: The description states "Retrieves local definitions for a given POA&M (same as GET /local-definitions but with consistent routing)" but this is incorrect. This endpoint retrieves a SPECIFIC local definition by its ID, while the GET /local-definitions endpoint (without definitionId) retrieves ALL local definitions for the POAM and merges them into a single response. The description should be updated to clarify that this endpoint retrieves a single specific local definition.