Skip to main content

Scoring & Linting

Score API specifications against governance rule sets and view detailed linting results.

Get governance graph​

The governance graph provides an overview of API compliance across your landscape:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/governance/graph" \
  -H "Authorization: Bearer <your-token>"

Get API scores​

Retrieve governance scores for APIs:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/governance/scores?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Score a specific API specification​

Score a spec file on demand:

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/governance/score" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "spec": "<spec-content-or-reference>"
  }'

Get linting results for an API​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/governance/apis/<api-id>/lint" \
  -H "Authorization: Bearer <your-token>"

The linting result includes:

  • Overall score — Numerical quality score
  • Rules — Which rules were evaluated
  • Issues — Specific violations with location and severity

Example response:

{
  "score": 85,
  "rules": [
    {
      "name": "operation-description",
      "severity": "warning"
    }
  ],
  "issues": [
    {
      "rule": "operation-description",
      "message": "Operation must have a description",
      "path": "/paths/~1pets/get",
      "severity": "warning"
    }
  ]
}

Get rule violations​

List all rule violations across APIs:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/governance/violations?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Organization scores​

Get governance scores aggregated by organization:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/governance/organizations/scores" \
  -H "Authorization: Bearer <your-token>"