← methodology

OpenAPI validity & quality

usability.openapi-quality · Usability · 3 pts · recommended

Goal

Is your integration well-built?

Whether your specs, docs, and tools are complete and descriptive enough for an agent to use them without guessing.

How we test

Linted the spec: descriptions, operationIds, securitySchemes, servers.

How to pass

Agents generate calls directly from your spec — operation descriptions and securitySchemes are load-bearing; fill them in.

Verify a fix

curl -X POST /api/scan/checks \
  -H 'content-type: application/json' \
  -d '{"url": "yourdomain.com", "checkIds": ["usability.openapi-quality"]}'