devguard

CoverageAdoptions

Get framework adoptions with coverage statistics.

GET
/coverage/adoptions/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

organizationId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.devguard.ch/api/coverage/adoptions/?organizationId=string"
[
  {
    "id": "string",
    "frameworkId": "string",
    "organizationId": "string",
    "adoptedAt": "string",
    "adoptedBy": "string",
    "notes": "string",
    "framework": {
      "id": "string",
      "organizationId": "string",
      "identifier": "string",
      "slug": "string",
      "version": "1.0",
      "identifierColor": "string",
      "publishedAt": "string",
      "deprecatedAt": "string",
      "isActive": true,
      "requiredTier": "free-trial",
      "name": "string",
      "description": "string",
      "isCentralized": true,
      "lastSyncAt": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string"
    },
    "coverageStats": {
      "frameworkId": "string",
      "frameworkAdoptionId": "string",
      "totalControls": 0,
      "coveredControls": 0,
      "fullyCoveredControls": 0,
      "partiallyCoveredControls": 0,
      "uncoveredControls": 0,
      "coveragePercentage": 0
    }
  }
]
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?