{ "openapi": "3.1.0", "info": { "title": "Screenata Auditor Pull API", "version": "1.0.0", "description": "Read-only auditor-seat access. Bearer credentials are accepted only in the Authorization header. Completed cycles remain readable while the seat, grant, and token are valid. Missing control citations are null. Reads are logged. Limits: 600 JSON reads/minute and 60 content downloads/minute per token. Evidence cursors are live offsets; concurrent evidence changes can move page boundaries. Packages expose the latest 50 entries, matching the portal. Content hrefs are relative to the API host." }, "servers": [ { "url": "https://api.screenata.com/api/audit" } ], "security": [ { "AuditorToken": [] } ], "components": { "securitySchemes": { "AuditorToken": { "type": "http", "scheme": "bearer", "description": "Personal auditor token created in Auditor Center." } }, "schemas": { "RunEvaluation": { "type": "object", "required": [ "resultStatus", "evaluatedAt", "noInScopeResources", "passed", "failed", "inconclusive", "excepted", "exceptionIds" ], "properties": { "resultStatus": { "type": [ "string", "null" ] }, "evaluatedAt": { "type": "string" }, "noInScopeResources": { "type": "boolean" }, "passed": { "type": "number" }, "failed": { "type": "number" }, "inconclusive": { "type": "number" }, "excepted": { "type": "number" }, "exceptionIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CheckRunSummary": { "type": "object", "required": [ "id", "phase", "resultStatus", "rawResultStatus", "evaluation", "startedAt", "finishedAt", "durationMs" ], "properties": { "id": { "type": "string" }, "phase": { "type": "string" }, "resultStatus": { "type": [ "string", "null" ] }, "rawResultStatus": { "type": [ "string", "null" ] }, "evaluation": { "$ref": "#/components/schemas/RunEvaluation" }, "startedAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "durationMs": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "CheckHistory": { "type": "object", "required": [ "schemaVersion", "generatedAt", "checkKey", "provider", "from", "to", "runs", "latestRun", "nextCursor" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "checkKey": { "type": [ "string", "null" ], "description": "The check currently bound to the test; null once unbound, while its recorded runs stay readable." }, "provider": { "type": [ "string", "null" ] }, "from": { "type": [ "string", "null" ], "format": "date-time", "description": "The requested lower bound; null when omitted (the audit period start applies)." }, "to": { "type": [ "string", "null" ], "format": "date-time", "description": "The requested upper bound; null when omitted (the audit period end, or completion, applies)." }, "runs": { "type": "array", "items": { "$ref": "#/components/schemas/CheckRunSummary" } }, "latestRun": { "anyOf": [ { "$ref": "#/components/schemas/CheckRunSummary" }, { "type": "null" } ] }, "nextCursor": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "CheckExecution": { "type": "object", "required": [ "id", "checkId", "connectionId", "sourceRunId", "sourceRunType", "initiatedBy", "executor", "sourceProvider", "startedAt", "finishedAt", "variables", "requests" ], "properties": { "id": { "type": "string" }, "checkId": { "type": "string" }, "connectionId": { "type": "string" }, "sourceRunId": { "type": [ "string", "null" ] }, "sourceRunType": { "type": [ "string", "null" ], "enum": [ "api_test", "compliance_scan", null ] }, "initiatedBy": { "type": [ "string", "null" ] }, "executor": { "type": "object", "required": [ "name", "version", "runtime" ], "properties": { "name": { "const": "Screenata native check engine", "type": "string" }, "version": { "type": [ "string", "null" ] }, "runtime": { "type": "string" } }, "additionalProperties": false }, "sourceProvider": { "type": "string" }, "startedAt": { "type": "string" }, "finishedAt": { "type": "string" }, "variables": { "type": "object", "additionalProperties": true }, "requests": { "type": "array", "items": { "type": "object", "required": [ "id", "timestamp", "provider", "operation", "durationMs", "request" ], "additionalProperties": false, "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "provider": { "type": "string" }, "operation": { "type": "string" }, "durationMs": { "type": "number" }, "request": { "type": "object", "additionalProperties": true }, "response": { "type": "object", "additionalProperties": true }, "error": { "type": "object", "additionalProperties": true } } } } }, "additionalProperties": false }, "Error": { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "const": false, "type": "boolean" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "Cycle": { "type": "object", "required": [ "id", "organizationName", "label", "framework", "auditType", "periodStart", "periodEnd", "status" ], "properties": { "id": { "type": "string" }, "organizationName": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "framework": { "type": [ "string", "null" ] }, "auditType": { "type": [ "string", "null" ] }, "periodStart": { "type": [ "string", "null" ], "format": "date-time" }, "periodEnd": { "type": [ "string", "null" ], "format": "date-time" }, "status": { "type": "string" } }, "additionalProperties": false }, "Cycles": { "type": "object", "required": [ "schemaVersion", "generatedAt", "items", "totalCount", "nextCursor" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Cycle" } }, "totalCount": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "CycleDetail": { "type": "object", "required": [ "schemaVersion", "generatedAt", "cycle", "readiness", "stats" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "cycle": { "$ref": "#/components/schemas/Cycle" }, "readiness": { "anyOf": [ { "type": "object", "required": [ "overallScore", "capturedAt" ], "properties": { "overallScore": { "type": "number" }, "capturedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, { "type": "null" } ] }, "stats": { "type": "object", "required": [ "totalTests", "completeTests", "totalControls", "completeControls", "evidenceArtifacts", "verifiedPolicies", "testReview" ], "properties": { "totalTests": { "type": "number" }, "completeTests": { "type": "number" }, "totalControls": { "type": "number" }, "completeControls": { "type": "number" }, "evidenceArtifacts": { "type": "number" }, "verifiedPolicies": { "type": "number" }, "testReview": { "type": "object", "required": [ "reviewed", "inScope", "satisfactory", "exceptionNoted", "needsRemediation", "reviewedOnly", "pending" ], "properties": { "reviewed": { "type": "number" }, "inScope": { "type": "number" }, "satisfactory": { "type": "number" }, "exceptionNoted": { "type": "number" }, "needsRemediation": { "type": "number" }, "reviewedOnly": { "type": "number" }, "pending": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "Test": { "type": "object", "required": [ "id", "code", "title", "status", "reviewStatus", "submissionStatus", "scopeState", "automated", "checkKey" ], "properties": { "id": { "type": "string" }, "code": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "status": { "type": "string" }, "reviewStatus": { "type": [ "string", "null" ] }, "submissionStatus": { "type": [ "string", "null" ] }, "scopeState": { "type": "string" }, "automated": { "type": "boolean", "description": "True when the test is currently bound to an automated check. List its runs at /tests/{statusId}/runs." }, "checkKey": { "type": [ "string", "null" ], "description": "The bound automated check, for example github.branch-protection; null when none is bound." } }, "additionalProperties": false }, "Control": { "type": "object", "required": [ "controlRef", "title", "description", "citations", "status", "effectiveAuditStatus", "tests" ], "properties": { "controlRef": { "type": [ "string", "null" ], "description": "The control as the auditor sees it: the framework citation for this cycle where one exists (for example CC6.1), otherwise Screenata's display code (for example GOV-01). Never the internal SC-nnn id, which earlier versions returned." }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "citations": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "effectiveAuditStatus": { "type": "string" }, "tests": { "type": "array", "items": { "$ref": "#/components/schemas/Test" } } }, "additionalProperties": false }, "Controls": { "type": "object", "required": [ "schemaVersion", "generatedAt", "groups", "totalCount", "nextCursor" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "items": { "type": "object", "required": [ "framework", "controls" ], "properties": { "framework": { "type": "string" }, "controls": { "type": "array", "items": { "$ref": "#/components/schemas/Control" } } }, "additionalProperties": false } }, "totalCount": { "type": "number" }, "nextCursor": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "CheckRun": { "type": "object", "required": [ "schemaVersion", "generatedAt", "id", "resultStatus", "startedAt", "phase", "finishedAt", "durationMs", "evaluation", "resources", "canonicalEvidence", "executions" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "resultStatus": { "type": [ "string", "null" ] }, "startedAt": { "type": "string" }, "phase": { "type": "string" }, "finishedAt": { "type": [ "string", "null" ], "format": "date-time" }, "durationMs": { "type": [ "number", "null" ] }, "evaluation": { "$ref": "#/components/schemas/RunEvaluation" }, "resources": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "canonicalEvidence": { "type": "array", "items": { "type": "object", "required": [ "canonicalType", "rows" ], "properties": { "canonicalType": { "type": "string" }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": false } }, "executions": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CheckExecution" } } }, "additionalProperties": false }, "File": { "type": "object", "required": [ "id", "title", "fileType", "sizeBytes", "contentSha256", "content", "executions" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "fileType": { "type": [ "string", "null" ] }, "sizeBytes": { "type": [ "number", "null" ] }, "contentSha256": { "type": [ "string", "null" ] }, "content": { "type": [ "string", "null" ] }, "executions": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CheckExecution" }, "description": "Request provenance of an automated check result file, read from the file itself. Populated on evidence-item and submission responses; always null in list responses — fetch the item, or download the file." } }, "additionalProperties": false }, "EvidenceItem": { "type": "object", "required": [ "id", "title", "fileType", "sizeBytes", "contentSha256", "content", "executions", "kind", "controlRef", "reviewStatus", "submittedAt", "uploadedAt", "linkedFiles" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "fileType": { "type": [ "string", "null" ] }, "sizeBytes": { "type": [ "number", "null" ] }, "contentSha256": { "type": [ "string", "null" ] }, "content": { "type": [ "string", "null" ] }, "executions": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/CheckExecution" }, "description": "Request provenance of an automated check result file, read from the file itself. Populated on evidence-item and submission responses; always null in list responses — fetch the item, or download the file." }, "kind": { "type": "string", "enum": [ "file", "submission" ] }, "controlRef": { "type": [ "string", "null" ], "description": "The control as the auditor sees it: the framework citation for this cycle where one exists (for example CC6.1), otherwise Screenata's display code (for example GOV-01). Never the internal SC-nnn id, which earlier versions returned." }, "reviewStatus": { "type": [ "string", "null" ] }, "submittedAt": { "type": [ "string", "null" ], "format": "date-time" }, "uploadedAt": { "type": [ "string", "null" ], "format": "date-time" }, "linkedFiles": { "type": "array", "items": { "$ref": "#/components/schemas/File" } } }, "additionalProperties": false }, "EvidenceDetail": { "type": "object", "required": [ "schemaVersion", "generatedAt", "item" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "item": { "$ref": "#/components/schemas/EvidenceItem" } }, "additionalProperties": false }, "EvidenceList": { "type": "object", "required": [ "schemaVersion", "generatedAt", "groups", "totalCount", "nextCursor" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "items": { "type": "object", "required": [ "controlRef", "controlTitle", "items" ], "properties": { "controlRef": { "type": [ "string", "null" ], "description": "The control as the auditor sees it: the framework citation for this cycle where one exists (for example CC6.1), otherwise Screenata's display code (for example GOV-01). Never the internal SC-nnn id, which earlier versions returned." }, "controlTitle": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EvidenceItem" } } }, "additionalProperties": false } }, "totalCount": { "type": "number" }, "nextCursor": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "Submission": { "type": "object", "required": [ "schemaVersion", "generatedAt", "id", "testId", "testCode", "testTitle", "revisionNumber", "reviewStatus", "submittedAt", "reviewedAt", "overallScore", "files", "reviewHistory" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "testId": { "type": "string" }, "testCode": { "type": [ "string", "null" ] }, "testTitle": { "type": [ "string", "null" ] }, "revisionNumber": { "type": "number" }, "reviewStatus": { "type": "string" }, "submittedAt": { "type": "string", "format": "date-time" }, "reviewedAt": { "type": [ "string", "null" ], "format": "date-time" }, "overallScore": { "type": [ "number", "null" ] }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/File" } }, "reviewHistory": { "type": "array", "items": { "type": "object", "required": [ "id", "reviewStatus", "createdAt" ], "properties": { "id": { "type": "string" }, "reviewStatus": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "description": "Recorded customer submission-review events, oldest first. Historical logging gaps are not reconstructed. This is separate from auditor Test verdicts." } }, "additionalProperties": false }, "Policy": { "type": "object", "required": [ "slug", "title", "version", "approvedAt", "submissionId", "submissionStatus", "submittedAt", "reviewedAt", "reviewStatus", "controlRefs" ], "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "version": { "type": "number" }, "approvedAt": { "type": [ "string", "null" ], "format": "date-time" }, "submissionId": { "type": [ "string", "null" ] }, "submissionStatus": { "type": [ "string", "null" ] }, "submittedAt": { "type": [ "string", "null" ], "format": "date-time" }, "reviewedAt": { "type": [ "string", "null" ], "format": "date-time" }, "reviewStatus": { "type": [ "string", "null" ] }, "controlRefs": { "type": "array", "items": { "type": "string" }, "description": "The control as the auditor sees it: the framework citation for this cycle where one exists (for example CC6.1), otherwise Screenata's display code (for example GOV-01). Never the internal SC-nnn id, which earlier versions returned." } }, "additionalProperties": false }, "Policies": { "type": "object", "required": [ "schemaVersion", "generatedAt", "items", "totalCount", "nextCursor" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Policy" } }, "totalCount": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "PolicyDetail": { "type": "object", "required": [ "schemaVersion", "generatedAt", "slug", "title", "version", "approvedAt", "submissionId", "submissionStatus", "submittedAt", "reviewedAt", "reviewStatus", "controlRefs", "content" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "slug": { "type": "string" }, "title": { "type": "string" }, "version": { "type": "number" }, "approvedAt": { "type": [ "string", "null" ], "format": "date-time" }, "submissionId": { "type": [ "string", "null" ] }, "submissionStatus": { "type": [ "string", "null" ] }, "submittedAt": { "type": [ "string", "null" ], "format": "date-time" }, "reviewedAt": { "type": [ "string", "null" ], "format": "date-time" }, "reviewStatus": { "type": [ "string", "null" ] }, "controlRefs": { "type": "array", "items": { "type": "string" }, "description": "The control as the auditor sees it: the framework citation for this cycle where one exists (for example CC6.1), otherwise Screenata's display code (for example GOV-01). Never the internal SC-nnn id, which earlier versions returned." }, "content": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "Package": { "type": "object", "required": [ "id", "status", "fileName", "sizeBytes", "artifactCount", "manifestHash", "createdAt", "content" ], "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "fileName": { "type": [ "string", "null" ] }, "sizeBytes": { "type": [ "number", "null" ] }, "artifactCount": { "type": [ "number", "null" ] }, "manifestHash": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "content": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "Packages": { "type": "object", "required": [ "schemaVersion", "generatedAt", "items" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Package" } } }, "additionalProperties": false }, "Population": { "type": "object", "required": [ "id", "class", "name", "asOfDate", "periodStart", "periodEnd", "interim", "recordCount", "excludedCount", "headers", "hiddenColumns", "fileHash", "frozenAt", "content" ], "properties": { "id": { "type": "string" }, "class": { "type": "string", "enum": [ "people", "devices", "changes" ] }, "name": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "periodStart": { "type": [ "string", "null" ], "format": "date-time" }, "periodEnd": { "type": [ "string", "null" ], "format": "date-time" }, "interim": { "type": "boolean", "description": "Frozen before periodEnd; re-freeze after the window closes for a final population." }, "recordCount": { "type": "number" }, "excludedCount": { "type": "number" }, "headers": { "type": "array", "items": { "type": "string" }, "description": "Visible columns only; hidden columns are listed separately and never served." }, "hiddenColumns": { "type": "array", "items": { "type": "string" } }, "fileHash": { "type": [ "string", "null" ], "description": "SHA-256 of the served CSV; null when columns are hidden (verify with X-Content-Sha256 on /content)." }, "frozenAt": { "type": "string", "format": "date-time" }, "content": { "type": "string" } }, "additionalProperties": false }, "Populations": { "type": "object", "required": [ "schemaVersion", "generatedAt", "items", "totalCount", "nextCursor" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Population" } }, "totalCount": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "PopulationRows": { "type": "object", "required": [ "schemaVersion", "generatedAt", "populationId", "headers", "hiddenColumns", "items", "totalCount", "nextCursor" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "populationId": { "type": "string" }, "headers": { "type": "array", "items": { "type": "string" } }, "hiddenColumns": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": true, "required": [ "rowIndex" ], "properties": { "rowIndex": { "type": "number" } } } }, "totalCount": { "type": "number" }, "nextCursor": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "Sample": { "type": "object", "required": [ "id", "populationId", "round", "method", "sampleSize", "seed", "selectedAt", "notes" ], "properties": { "id": { "type": "string" }, "populationId": { "type": "string" }, "round": { "type": "number" }, "method": { "type": "string" }, "sampleSize": { "type": "number" }, "seed": { "type": [ "number", "null" ] }, "selectedAt": { "type": "string", "format": "date-time" }, "notes": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "Samples": { "type": "object", "required": [ "schemaVersion", "generatedAt", "items", "totalCount", "nextCursor" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Sample" } }, "totalCount": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "SampleDetail": { "type": "object", "required": [ "schemaVersion", "generatedAt", "id", "populationId", "round", "method", "sampleSize", "seed", "selectedAt", "notes", "items" ], "properties": { "schemaVersion": { "type": "string", "const": "audit-api/1.0" }, "generatedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "populationId": { "type": "string" }, "round": { "type": "number" }, "method": { "type": "string" }, "sampleSize": { "type": "number" }, "seed": { "type": [ "number", "null" ] }, "selectedAt": { "type": "string", "format": "date-time" }, "notes": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "rowIndex", "identifier", "rowData", "evidenceSnapshot", "evidenceSnapshotAt", "replacesSampleItemId" ], "properties": { "id": { "type": "string" }, "rowIndex": { "type": "number" }, "identifier": { "type": "string" }, "rowData": { "type": "object", "additionalProperties": true }, "evidenceSnapshot": { "description": "Evidence set frozen at pick time; rendered from this, never from live data." }, "evidenceSnapshotAt": { "type": [ "string", "null" ], "format": "date-time" }, "replacesSampleItemId": { "type": [ "string", "null" ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "paths": { "/v1/cycles": { "get": { "operationId": "listCycles", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Cycles" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}": { "get": { "operationId": "getCycle", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/CycleDetail" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/controls": { "get": { "operationId": "listControls", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "all", "complete", "in_progress", "pending" ] } }, { "name": "reviewStatus", "in": "query", "schema": { "type": "string", "enum": [ "all", "none", "SATISFACTORY", "EXCEPTION_NOTED", "NEEDS_REMEDIATION" ] } }, { "name": "framework", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Controls" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/evidence": { "get": { "operationId": "listEvidence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "reviewStatus", "in": "query", "schema": { "type": "string", "enum": [ "all", "none", "PENDING", "APPROVED", "NEEDS_REVISION" ] } }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "all", "file", "submission" ] } }, { "name": "controlId", "in": "query", "schema": { "type": "string" }, "description": "Filter by a control reference exactly as returned in `controlRef`." }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/EvidenceList" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/evidence/{kind}/{itemId}": { "get": { "operationId": "getEvidence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "file", "submission" ] } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/EvidenceDetail" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/submissions/{submissionId}": { "get": { "operationId": "getSubmission", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Submission" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/policies": { "get": { "operationId": "listPolicies", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Policies" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/policies/{slug}": { "get": { "operationId": "getPolicy", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PolicyDetail" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/packages": { "get": { "operationId": "listPackages", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Packages" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/tests/{statusId}/runs": { "get": { "operationId": "listCheckRuns", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statusId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Optional inclusive bound, from <= to. Omit both for the whole audit period. Only runs in the intersection with the audit period are returned, newest first; follow nextCursor to the last page. While the cycle is open a new run can shift a page by one, so de-duplicate by run id. Latest run is returned separately within the audit period and may be outside this window." }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Optional inclusive bound, from <= to. Omit both for the whole audit period. Only runs in the intersection with the audit period are returned, newest first; follow nextCursor to the last page. While the cycle is open a new run can shift a page by one, so de-duplicate by run id. Latest run is returned separately within the audit period and may be outside this window." }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/CheckHistory" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/tests/{statusId}/runs/{runId}": { "get": { "operationId": "getCheckRun", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statusId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/CheckRun" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/evidence/file/{fileId}/content": { "get": { "operationId": "downloadEvidence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "submissionId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authenticated file bytes", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } }, "X-Content-Sha256": { "schema": { "type": "string" } }, "Content-Disposition": { "schema": { "type": "string" } } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/packages/{pkgId}/content": { "get": { "operationId": "downloadPackage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pkgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authenticated file bytes", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } }, "X-Content-Sha256": { "schema": { "type": "string" } }, "Content-Disposition": { "schema": { "type": "string" } }, "X-Manifest-Hash": { "schema": { "type": "string" } } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/populations": { "get": { "operationId": "listPopulations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Populations" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/populations/{popId}": { "get": { "operationId": "getPopulationRows", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "popId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PopulationRows" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/populations/{popId}/content": { "get": { "operationId": "downloadPopulation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "popId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authenticated file bytes", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } }, "X-Content-Sha256": { "schema": { "type": "string" } }, "Content-Disposition": { "schema": { "type": "string" } } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/populations/{popId}/samples": { "get": { "operationId": "listSamples", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "popId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/Samples" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/cycles/{id}/samples/{sampleId}": { "get": { "operationId": "getSample", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sampleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "X-Audit-API-Version": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/SampleDetail" } }, "additionalProperties": false } } } }, "400": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" } } } }, "500": { "description": "Error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required service unavailable, including unreadable historical run evidence. Rate-limit outages include a Retry-After delay and do not read audit data.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/openapi.json": { "get": { "operationId": "getOpenApi", "security": [], "responses": { "200": { "description": "This OpenAPI document", "content": { "application/json": { "schema": { "type": "object" } } } } } } } } }