Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
233 changes: 233 additions & 0 deletions docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -20710,6 +20710,194 @@ const docTemplate = `{
]
}
},
"/oscal/system-security-plans/{id}/export-offerings/{offeringId}/allowed-downstreams": {
"get": {
"description": "Returns every downstream SSP allow-listed to subscribe to this offering\n(BCH-1342). An empty list means the offering has no allow-list set — any\ndownstream may subscribe (subject to the existing ssp:update and\ncontributor-role checks), the type-level default.",
"produces": [
"application/json"
],
"tags": [
"SSP Export Offerings"
],
"summary": "List an export offering's downstream-SSP allow-list",
"parameters": [
{
"type": "string",
"description": "SSP ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Offering ID",
"name": "offeringId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataListResponse-relational_SSPExportOfferingAllowedDownstream"
}
},
"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"
}
}
},
"security": [
{
"OAuth2Password": []
}
]
},
"post": {
"description": "Once an offering has at least one allow-list entry, only listed downstream\nSSPs may subscribe to it (BCH-1342) — enforced by a handler-level check in\nSubscribe, not by the PDP.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"SSP Export Offerings"
],
"summary": "Add a downstream SSP to an export offering's allow-list",
"parameters": [
{
"type": "string",
"description": "SSP ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Offering ID",
"name": "offeringId",
"in": "path",
"required": true
},
{
"description": "Downstream SSP to allow",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/oscal.allowedDownstreamRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-relational_SSPExportOfferingAllowedDownstream"
}
},
"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"
}
}
},
"security": [
{
"OAuth2Password": []
}
]
}
},
"/oscal/system-security-plans/{id}/export-offerings/{offeringId}/allowed-downstreams/{downstreamSspId}": {
"delete": {
"description": "If this removes the offering's last allow-list entry, the offering\nreverts to the type-level default (any downstream may subscribe,\nsubject to the existing ssp:update and contributor-role checks).",
"tags": [
"SSP Export Offerings"
],
"summary": "Remove a downstream SSP from an export offering's allow-list",
"parameters": [
{
"type": "string",
"description": "SSP ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Offering ID",
"name": "offeringId",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Downstream SSP ID",
"name": "downstreamSspId",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
},
"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"
}
}
},
"security": [
{
"OAuth2Password": []
}
]
}
Comment thread
saltpy-cs marked this conversation as resolved.
},
"/oscal/system-security-plans/{id}/export-offerings/{offeringId}/items": {
"post": {
"description": "Adds one offered capability (a control, optionally scoped to a statement, implemented by a component) to a draft export offering.",
Expand Down Expand Up @@ -33731,6 +33919,19 @@ const docTemplate = `{
"meta": {}
}
},
"handler.GenericDataListResponse-relational_SSPExportOfferingAllowedDownstream": {
"type": "object",
"properties": {
"data": {
"description": "Items from the list response",
"type": "array",
"items": {
"$ref": "#/definitions/relational.SSPExportOfferingAllowedDownstream"
}
},
"meta": {}
}
},
"handler.GenericDataListResponse-relational_SSPLeverageLink": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -35118,6 +35319,19 @@ const docTemplate = `{
}
}
},
"handler.GenericDataResponse-relational_SSPExportOfferingAllowedDownstream": {
"type": "object",
"properties": {
"data": {
"description": "Wrapped response data",
"allOf": [
{
"$ref": "#/definitions/relational.SSPExportOfferingAllowedDownstream"
}
]
}
}
},
"handler.GenericDataResponse-relational_SSPExportOfferingItem": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -38201,6 +38415,14 @@ const docTemplate = `{
}
}
},
"oscal.allowedDownstreamRequest": {
"type": "object",
"properties": {
"downstreamSspId": {
"type": "string"
}
}
},
"oscal.catalogOffering": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -45870,6 +46092,17 @@ const docTemplate = `{
}
}
},
"relational.SSPExportOfferingAllowedDownstream": {
"type": "object",
"properties": {
"downstreamSspId": {
"type": "string"
},
"offeringId": {
"type": "string"
}
}
},
"relational.SSPExportOfferingItem": {
"type": "object",
"properties": {
Expand Down
Loading
Loading