Methodologie
Bruikbaarheid van OpenAPI
ia.openapi-quality · 4.17
Handelen
ZOU MOETEN
Aanbeveling
AR-ACT-02
Waarom het belangrijk is
Een OpenAPI-document helpt agents alleen als elke operatie concreet is. Agents hebben operationId, beschrijvingen, getypeerde parameters en responseschema's nodig voor een correcte call.
Zo los je het op
Geef elke operatie een operationId, een beschrijving, getypeerde parameters en responseschema's.
-
Voeg een unieke operationId en een beschrijving toe aan elke operatie.
-
Voeg aan elke parameter en elke response een schema met type toe.
"parameters": [{"name": "q", "in": "query", "required": true, "schema": {"type": "string"}}]
Controleren
curl -sf https://{domain}/openapi.json | jq -e '[.paths[][] | objects | has("operationId")] | all'
Verwacht: exitcode 0
Start een nieuwe scan voor dit checkpoint:
isagentready results {domain} --checkpoint ia.openapi-quality
Details Koppeling, levenscyclus en bronnen
- AR-koppeling
- Volledige match
- Bron van het bewijs
- agentready.org AR-ACT-02
- Rol in de score
- Kern
- Toegevoegd
- 2026-08-24
- Herzien
- 2026-08-29
- Methodologieversie
- 2026-10-22