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
110 changes: 110 additions & 0 deletions docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -3914,6 +3914,64 @@ const docTemplate = `{
}
}
},
"/evidence/{id}/risks": {
"get": {
"description": "Retrieves every risk register entry linked to the evidence record's stream, across all System Security Plans.",
"produces": [
"application/json"
],
"tags": [
"Evidence"
],
"summary": "List Risks linked to an Evidence stream",
"parameters": [
{
"type": "string",
"description": "Evidence ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataListResponse-handler_EvidenceRiskResponse"
}
},
"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": []
}
]
}
},
"/evidence/{id}/signature": {
"get": {
"description": "Retrieves the stored signature envelope for a single Evidence record.",
Expand Down Expand Up @@ -32936,6 +32994,38 @@ const docTemplate = `{
}
}
},
"handler.EvidenceRiskResponse": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"impact": {
"type": "string"
},
"likelihood": {
"type": "string"
},
"source-type": {
"type": "string"
},
"ssp-id": {
"type": "string"
},
"ssp-title": {
"type": "string"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
}
}
},
"handler.EvidenceSignatureResponse": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -33113,6 +33203,19 @@ const docTemplate = `{
"meta": {}
}
},
"handler.GenericDataListResponse-handler_EvidenceRiskResponse": {
"type": "object",
"properties": {
"data": {
"description": "Items from the list response",
"type": "array",
"items": {
"$ref": "#/definitions/handler.EvidenceRiskResponse"
}
},
"meta": {}
}
},
"handler.GenericDataListResponse-handler_FilterWithAssociations": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -35588,6 +35691,13 @@ const docTemplate = `{
"sspBreakdown": {
"$ref": "#/definitions/handler.LineageSSPBreakdown"
},
"sspId": {
"description": "RiskSSPID/RiskSSPTitle identify the single SSP a risk node belongs to\n(risk_register_risks.ssp_id is not-null — every risk has exactly one).\nPopulated regardless of scope so the UI can group risk nodes by SSP in\nthe unscoped \"All SSPs\" view.",
"type": "string"
},
"sspTitle": {
"type": "string"
},
"statement": {
"description": "Statement is the control's requirement prose (OSCAL \"statement\" part),\nsurfaced for hover/tooltip in the lineage tree \u0026 graph. Control nodes only.",
"type": "string"
Expand Down
110 changes: 110 additions & 0 deletions docs/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -3908,6 +3908,64 @@
}
}
},
"/evidence/{id}/risks": {
"get": {
"description": "Retrieves every risk register entry linked to the evidence record's stream, across all System Security Plans.",
"produces": [
"application/json"
],
"tags": [
"Evidence"
],
"summary": "List Risks linked to an Evidence stream",
"parameters": [
{
"type": "string",
"description": "Evidence ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataListResponse-handler_EvidenceRiskResponse"
}
},
"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": []
}
]
}
},
"/evidence/{id}/signature": {
"get": {
"description": "Retrieves the stored signature envelope for a single Evidence record.",
Expand Down Expand Up @@ -32930,6 +32988,38 @@
}
}
},
"handler.EvidenceRiskResponse": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"impact": {
"type": "string"
},
"likelihood": {
"type": "string"
},
"source-type": {
"type": "string"
},
"ssp-id": {
"type": "string"
},
"ssp-title": {
"type": "string"
},
"status": {
"type": "string"
},
"title": {
"type": "string"
}
}
},
"handler.EvidenceSignatureResponse": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -33107,6 +33197,19 @@
"meta": {}
}
},
"handler.GenericDataListResponse-handler_EvidenceRiskResponse": {
"type": "object",
"properties": {
"data": {
"description": "Items from the list response",
"type": "array",
"items": {
"$ref": "#/definitions/handler.EvidenceRiskResponse"
}
},
"meta": {}
}
},
"handler.GenericDataListResponse-handler_FilterWithAssociations": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -35582,6 +35685,13 @@
"sspBreakdown": {
"$ref": "#/definitions/handler.LineageSSPBreakdown"
},
"sspId": {
"description": "RiskSSPID/RiskSSPTitle identify the single SSP a risk node belongs to\n(risk_register_risks.ssp_id is not-null — every risk has exactly one).\nPopulated regardless of scope so the UI can group risk nodes by SSP in\nthe unscoped \"All SSPs\" view.",
"type": "string"
},
"sspTitle": {
"type": "string"
},
"statement": {
"description": "Statement is the control's requirement prose (OSCAL \"statement\" part),\nsurfaced for hover/tooltip in the lineage tree \u0026 graph. Control nodes only.",
"type": "string"
Expand Down
77 changes: 77 additions & 0 deletions docs/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,27 @@ definitions:
for a specific purpose.\""
type: string
type: object
handler.EvidenceRiskResponse:
properties:
description:
type: string
id:
type: string
impact:
type: string
likelihood:
type: string
source-type:
type: string
ssp-id:
type: string
ssp-title:
type: string
status:
type: string
title:
type: string
type: object
handler.EvidenceSignatureResponse:
properties:
data:
Expand Down Expand Up @@ -535,6 +556,15 @@ definitions:
type: array
meta: {}
type: object
handler.GenericDataListResponse-handler_EvidenceRiskResponse:
properties:
data:
description: Items from the list response
items:
$ref: '#/definitions/handler.EvidenceRiskResponse'
type: array
meta: {}
type: object
handler.GenericDataListResponse-handler_FilterWithAssociations:
properties:
data:
Expand Down Expand Up @@ -2038,6 +2068,15 @@ definitions:
SSPBreakdown replaces both in the global (no sspId) view on control nodes.
sspBreakdown:
$ref: '#/definitions/handler.LineageSSPBreakdown'
sspId:
description: |-
RiskSSPID/RiskSSPTitle identify the single SSP a risk node belongs to
(risk_register_risks.ssp_id is not-null — every risk has exactly one).
Populated regardless of scope so the UI can group risk nodes by SSP in
the unscoped "All SSPs" view.
type: string
sspTitle:
type: string
statement:
description: |-
Statement is the control's requirement prose (OSCAL "statement" part),
Expand Down Expand Up @@ -13687,6 +13726,44 @@ paths:
summary: Get Evidence by ID
tags:
- Evidence
/evidence/{id}/risks:
get:
description: Retrieves every risk register entry linked to the evidence record's
stream, across all System Security Plans.
parameters:
- description: Evidence ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/handler.GenericDataListResponse-handler_EvidenceRiskResponse'
"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: List Risks linked to an Evidence stream
tags:
- Evidence
/evidence/{id}/signature:
get:
description: Retrieves the stored signature envelope for a single Evidence record.
Expand Down
Loading
Loading