← methodology

OpenAPI spec discoverable

usability.openapi-discovery · Usability · 5 pts · required

Goal

Can an agent integrate with you?

Whether the artifacts an agent needs to build on you — docs, API specs, SDKs, MCP servers — exist and are findable.

How we test

Probed standard OpenAPI locations and docs links for a fetchable, parseable spec.

How to pass

Publish your OpenAPI spec at /openapi.json and link it from docs — it's the single highest-leverage artifact for agent integration.

Spec

https://spec.openapis.org/oas/latest.html ↗

Verify a fix

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