Skip to content

Compliance Dashboard implementation #328

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 4 commits into from
Feb 25, 2026
Merged

Compliance Dashboard implementation #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
38efb24
feat(oscal/profiles): add compliance-progress endpoint for profile co…
onselakin Feb 20, 2026
4622ce2
feat(oscal/profiles): enhance compliance progress response structure …
onselakin Feb 24, 2026
7c29037
integration test failing bug fix
onselakin Feb 24, 2026
0732bd8
feat(oscal/profiles): enhance compliance progress loading with statem…
onselakin Feb 24, 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
232 changes: 232 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11941,6 +11941,76 @@ const docTemplate = `{
]
}
},
"/oscal/profiles/{id}/compliance-progress": {
"get": {
"description": "Returns aggregated compliance progress for controls in a Profile, including summary, optional per-control rows, and group rollups.",
"produces": [
"application/json"
],
"tags": [
"Profile"
],
"summary": "Get compliance progress for a Profile",
"parameters": [
{
"type": "string",
"description": "Profile ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "boolean",
"description": "Include per-control breakdown (default true)",
"name": "includeControls",
"in": "query"
},
{
"type": "string",
"description": "System Security Plan ID for implementation coverage",
"name": "sspId",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handler.GenericDataResponse-oscal_ProfileComplianceProgress"
}
},
"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": []
}
]
}
},
"/oscal/profiles/{id}/full": {
"get": {
"description": "Retrieves the full OSCAL Profile, including all nested content.",
Expand Down Expand Up @@ -21369,6 +21439,19 @@ const docTemplate = `{
}
}
},
"handler.GenericDataResponse-oscal_ProfileComplianceProgress": {
"type": "object",
"properties": {
"data": {
"description": "Items from the list response",
"allOf": [
{
"$ref": "#/definitions/oscal.ProfileComplianceProgress"
}
]
}
}
},
"handler.GenericDataResponse-oscal_ProfileHandler": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -21845,6 +21928,155 @@ const docTemplate = `{
"MatchStrategyAny"
]
},
"oscal.ProfileComplianceControl": {
"type": "object",
"properties": {
"catalogId": {
"type": "string"
},
"computedStatus": {
"type": "string"
},
"controlId": {
"type": "string"
},
"groupId": {
"type": "string"
},
"groupTitle": {
"type": "string"
},
"implemented": {
"type": "boolean"
},
"statusCounts": {
"type": "array",
"items": {
"$ref": "#/definitions/oscal.ProfileComplianceStatusCount"
}
},
"title": {
"type": "string"
}
}
},
"oscal.ProfileComplianceGroup": {
"type": "object",
"properties": {
"compliancePercent": {
"type": "integer"
},
"id": {
"type": "string"
},
"notSatisfied": {
"type": "integer"
},
"satisfied": {
"type": "integer"
},
"title": {
"type": "string"
},
"totalControls": {
"type": "integer"
},
"unknown": {
"type": "integer"
}
}
},
"oscal.ProfileComplianceImplementation": {
"type": "object",
"properties": {
"implementationPercent": {
"type": "integer"
},
"implementedControls": {
"type": "integer"
},
"unimplementedControls": {
"type": "integer"
}
}
},
"oscal.ProfileComplianceProgress": {
"type": "object",
"properties": {
"controls": {
"type": "array",
"items": {
"$ref": "#/definitions/oscal.ProfileComplianceControl"
}
},
"groups": {
"type": "array",
"items": {
"$ref": "#/definitions/oscal.ProfileComplianceGroup"
}
},
"implementation": {
"$ref": "#/definitions/oscal.ProfileComplianceImplementation"
},
"scope": {
"$ref": "#/definitions/oscal.ProfileComplianceScope"
},
"summary": {
"$ref": "#/definitions/oscal.ProfileComplianceSummary"
}
}
},
"oscal.ProfileComplianceScope": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"oscal.ProfileComplianceStatusCount": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"status": {
"type": "string"
}
}
},
"oscal.ProfileComplianceSummary": {
"type": "object",
"properties": {
"assessedPercent": {
"type": "integer"
},
"compliancePercent": {
"type": "integer"
},
"implementedControls": {
"type": "integer"
},
"notSatisfied": {
"type": "integer"
},
"satisfied": {
"type": "integer"
},
"totalControls": {
"type": "integer"
},
"unknown": {
"type": "integer"
}
}
},
"oscal.ProfileHandler": {
"type": "object"
},
Expand Down
Loading