AIMLAPI · API Governance Rules
AIMLAPI API Rules
Spectral linting rules defining API design standards and conventions for AIMLAPI.
15 Rules
error 6
warn 8
info 1
Rule Categories
info
no
openai
operation
parameter
response
schema
security
servers
Rules
warn
info-title-aimlapi
Title should start with AIMLAPI
$.info.title
warn
operation-summary-prefix
Operation summaries must start with "AIMLAPI"
$.paths[*][get,post,put,patch,delete].summary
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
Every operation should have a description
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation should have tags
$.paths[*][get,post,put,patch,delete]
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
response-success-required
Operations must define at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
parameter-description
Parameters should have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
schema-property-type
Schema properties should have types defined
$.components.schemas[*].properties[*]
warn
security-bearer-defined
Bearer auth security scheme should be defined
$.components.securitySchemes
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
warn
no-empty-descriptions
Descriptions must not be empty
$..description
info
openai-compatible-model-param
Chat completion operations should have a model parameter
$.paths['/chat/completions'].post