Skip to content

feat: put endpoint for POAM local-defs #316

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

Merged
gusfcarvalho merged 3 commits into from
Jan 27, 2026
Merged

feat: put endpoint for POAM local-defs #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b282033
feat: put endpoint for local-defs
gusfcarvalho Jan 26, 2026
284d514
fix: copilot issues
gusfcarvalho Jan 27, 2026
9a8bdc1
fix: copilot issues
gusfcarvalho Jan 27, 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
57 changes: 57 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10634,6 +10634,63 @@ const docTemplate = `{
}
}
}
},
"put": {
"description": "Updates local-definitions for a given POA\u0026M with special handling of array and object fields.\n- Components and inventory-items arrays are treated as full replacements: the existing values on the POA\u0026M are overwritten by the arrays provided in the request body (no per-element merge is performed).\n- Sending an empty array [] for components or inventory-items clears that specific field (resulting in an empty array on the POA\u0026M).\n- Omitting a field in the request body leaves the existing value for that field unchanged.\n- Sending an empty JSON object {} as the payload deletes the entire local-definitions object for the POA\u0026M.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Plan Of Action and Milestones"
],
"summary": "Update POA\u0026M local-definitions",
"parameters": [
{
"type": "string",
"description": "POA\u0026M ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Local definitions data",
"name": "local-definitions",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/oscalTypes_1_1_3.PlanOfActionAndMilestonesLocalDefinitions"
}
}
],
"responses": {
"200": {
"description": "OK",
"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}/metadata": {
Expand Down
57 changes: 57 additions & 0 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10628,6 +10628,63 @@
}
}
}
},
"put": {
"description": "Updates local-definitions for a given POA\u0026M with special handling of array and object fields.\n- Components and inventory-items arrays are treated as full replacements: the existing values on the POA\u0026M are overwritten by the arrays provided in the request body (no per-element merge is performed).\n- Sending an empty array [] for components or inventory-items clears that specific field (resulting in an empty array on the POA\u0026M).\n- Omitting a field in the request body leaves the existing value for that field unchanged.\n- Sending an empty JSON object {} as the payload deletes the entire local-definitions object for the POA\u0026M.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Plan Of Action and Milestones"
],
"summary": "Update POA\u0026M local-definitions",
"parameters": [
{
"type": "string",
"description": "POA\u0026M ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Local definitions data",
"name": "local-definitions",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/oscalTypes_1_1_3.PlanOfActionAndMilestonesLocalDefinitions"
}
}
],
"responses": {
"200": {
"description": "OK",
"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}/metadata": {
Expand Down
43 changes: 43 additions & 0 deletions docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12562,6 +12562,49 @@ paths:
summary: Get POA&M local definitions
tags:
- Plan Of Action and Milestones
put:
consumes:
- application/json
description: |-
Updates local-definitions for a given POA&M with special handling of array and object fields.
- Components and inventory-items arrays are treated as full replacements: the existing values on the POA&M are overwritten by the arrays provided in the request body (no per-element merge is performed).
- Sending an empty array [] for components or inventory-items clears that specific field (resulting in an empty array on the POA&M).
- Omitting a field in the request body leaves the existing value for that field unchanged.
- Sending an empty JSON object {} as the payload deletes the entire local-definitions object for the POA&M.
parameters:
- description: POA&M ID
in: path
name: id
required: true
type: string
- description: Local definitions data
in: body
name: local-definitions
required: true
schema:
$ref: '#/definitions/oscalTypes_1_1_3.PlanOfActionAndMilestonesLocalDefinitions'
produces:
- application/json
responses:
"200":
description: OK
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'
summary: Update POA&M local-definitions
tags:
- Plan Of Action and Milestones
/oscal/plan-of-action-and-milestones/{id}/metadata:
get:
description: Retrieves metadata for a given POA&M.
Expand Down
Loading
Loading