{"id":"ia.openapi","name":"OpenAPI / API docs","verify":{"command":"curl -sf https://{domain}/openapi.json | jq -e '.openapi | startswith(\"3.\")'","rescan":"isagentready results {domain} --checkpoint ia.openapi","expect":"exit code 0"},"fix":{"steps":[{"action":"Generate an OpenAPI 3.1 document from the API code.","order":1,"language":"json","code_example":"{\n  \"openapi\": \"3.1.0\",\n  \"info\": {\"title\": \"Example API\", \"version\": \"1.0.0\"},\n  \"paths\": {\"/api/search\": {\"get\": {\"operationId\": \"search\", \"summary\": \"Search items\"}}}\n}"},{"action":"Serve it at /openapi.json or /.well-known/openapi with HTTP 200.","order":2,"language":null,"code_example":null},{"action":"Link it from the API catalog and a service-desc Link header.","order":3,"language":null,"code_example":null}],"summary":"Publish an OpenAPI 3.x document at /openapi.json and link it.","skill":{"name":"agent-protocols","anchor":"ia.openapi"}},"category":"agent_protocols","aggregate":null,"references":[{"title":"OpenAPI Specification","kind":"spec","url":"https://spec.openapis.org/oas/latest.html"},{"title":"Swagger Editor","kind":"guide","url":"https://editor.swagger.io/"}],"expected":"OpenAPI 3.x document at a well-known location","stage":"act","lifecycle":{"introduced":"2026-08-24","revised":[],"retired":null,"replaced_by":null},"methodology_version":"2026-10-22","evidence_tier":"standard","evidence_source":{"title":"agentready.org AR-ACT-02","url":"https://www.agentready.org/#act"},"why":"OpenAPI specifications let AI agents understand and call your API programmatically. AI coding assistants and agent frameworks use OpenAPI to generate correct API calls automatically.","profiles":["api_tool_readiness","agentic_commerce"],"score_role":"core","legacy_id":"4.5","i18n":{"nl":{"name":"OpenAPI / API-docs","steps":["Genereer een OpenAPI 3.1-document uit de API-code.","Lever het op /openapi.json of /.well-known/openapi met HTTP 200.","Link het vanuit de API-catalogus en een service-desc-Link-header."],"why":"OpenAPI-specificaties laten AI-agents je API begrijpen en aanroepen. AI-codeassistenten en agentframeworks gebruiken OpenAPI om correcte API-calls te maken.","fix_summary":"Publiceer een OpenAPI 3.x-document op /openapi.json en link het.","verify_expect":"exitcode 0"}},"ar_practice_ids":["AR-ACT-02"],"strength":"SHOULD","ar_mapping":"full","evidence_type":"measured_study","detail_url":"https://isagentready.com/en/methodology/checkpoints/ia.openapi","maturity":"recommended","applicability":{"mode":"detected_surface","condition":null,"surfaces":["api"]}}