Apifuse · API Governance Rules
Apifuse API Rules
Spectral linting rules defining API design standards and conventions for Apifuse.
10 Rules
error 4
warn 6
Rule Categories
info
operation
parameter
response
schema
servers
Rules
warn
info-title-prefix
API title must start with 'Apifuse'.
$.info
error
info-description-required
API must have a description.
$.info
error
servers-https
All server URLs must use HTTPS.
$.servers[*]
warn
operation-summary-prefix
Operation summaries must start with 'Apifuse'.
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camelcase
OperationId must use camelCase.
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have a 2xx response.
$.paths[*][get,post,put,patch,delete].responses
warn
schema-property-type-required
Schema properties must have a type defined.
$.components.schemas[*].properties[*]