Skip to content

BCH 994: Add single post endpoint for component/capability #284

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

Open
jonathandavies-CS wants to merge 5 commits into
base: main
Choose a base branch
from
Open

BCH 994: Add single post endpoint for component/capability #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
330bc0b
fix: also add single post for capabiity
jonathandavies-CS Oct 2, 2025
f393170
fix: update documentation
jonathandavies-CS Oct 2, 2025
c32a980
fix: preload metadata with shared func to update properly
jonathandavies-CS Oct 3, 2025
691dafb
fix: return relational capability
jonathandavies-CS Oct 3, 2025
9383733
fix: preload metadata
jonathandavies-CS Oct 3, 2025
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
140 changes: 140 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7542,6 +7542,146 @@ const docTemplate = `{
}
}
},
"/oscal/component-definitions/{id}/capability": {
"post": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Creates a new capability for a given component definition.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Component Definitions"
],
"summary": "Create a capability for a component definition",
"parameters": [
{
"type": "string",
"description": "Component Definition ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Capability",
"name": "capability",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/oscalTypes_1_1_3.Capability"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-oscalTypes_1_1_3_Capability"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
},
"401": {
"description": "Unauthorized",
"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/component-definitions/{id}/component": {
"post": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Creates a new component for a given component definition.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Component Definitions"
],
"summary": "Create a component for a component definition",
"parameters": [
{
"type": "string",
"description": "Component definition ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Component to create",
"name": "component",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/oscalTypes_1_1_3.DefinedComponent"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-oscalTypes_1_1_3_DefinedComponent"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
},
"401": {
"description": "Unauthorized",
"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/component-definitions/{id}/components": {
"get": {
"security": [
Expand Down
140 changes: 140 additions & 0 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7536,6 +7536,146 @@
}
}
},
"/oscal/component-definitions/{id}/capability": {
"post": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Creates a new capability for a given component definition.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Component Definitions"
],
"summary": "Create a capability for a component definition",
"parameters": [
{
"type": "string",
"description": "Component Definition ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Capability",
"name": "capability",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/oscalTypes_1_1_3.Capability"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-oscalTypes_1_1_3_Capability"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
},
"401": {
"description": "Unauthorized",
"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/component-definitions/{id}/component": {
"post": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Creates a new component for a given component definition.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Component Definitions"
],
"summary": "Create a component for a component definition",
"parameters": [
{
"type": "string",
"description": "Component definition ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Component to create",
"name": "component",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/oscalTypes_1_1_3.DefinedComponent"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-oscalTypes_1_1_3_DefinedComponent"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
},
"401": {
"description": "Unauthorized",
"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/component-definitions/{id}/components": {
"get": {
"security": [
Expand Down
90 changes: 90 additions & 0 deletions docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10420,6 +10420,96 @@ paths:
summary: Create incorporates components for a component definition
tags:
- Component Definitions
/oscal/component-definitions/{id}/capability:
post:
consumes:
- application/json
description: Creates a new capability for a given component definition.
parameters:
- description: Component Definition ID
in: path
name: id
required: true
type: string
- description: Capability
in: body
name: capability
required: true
schema:
$ref: '#/definitions/oscalTypes_1_1_3.Capability'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/handler.GenericDataResponse-oscalTypes_1_1_3_Capability'
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/api.Error'
"404":
description: Not Found
schema:
$ref: '#/definitions/api.Error'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/api.Error'
security:
- OAuth2Password: []
summary: Create a capability for a component definition
tags:
- Component Definitions
/oscal/component-definitions/{id}/component:
post:
consumes:
- application/json
description: Creates a new component for a given component definition.
parameters:
- description: Component definition ID
in: path
name: id
required: true
type: string
- description: Component to create
in: body
name: component
required: true
schema:
$ref: '#/definitions/oscalTypes_1_1_3.DefinedComponent'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/handler.GenericDataResponse-oscalTypes_1_1_3_DefinedComponent'
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/api.Error'
"404":
description: Not Found
schema:
$ref: '#/definitions/api.Error'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/api.Error'
security:
- OAuth2Password: []
summary: Create a component for a component definition
tags:
- Component Definitions
/oscal/component-definitions/{id}/components:
get:
description: Retrieves all components for a given component definition.
Expand Down
Loading