Academy Software Foundation · API Governance Rules
Academy Software Foundation API Rules
Spectral linting rules defining API design standards and conventions for Academy Software Foundation.
21 Rules
error 14
warn 5
info 2
Rule Categories
delete
get
info
no
openapi
operation
parameter
paths
response
schema
servers
Rules
error
info-title-required
Info title must be present and start with "Academy Software Foundation"
$.info
error
info-description-required
Info description must be present and be descriptive
$.info
error
info-version-required
Info version must be present
$.info
error
openapi-version-3
Must use OpenAPI 3.0.x
$
error
servers-required
At least one server must be defined
$
warn
servers-description-required
Servers should have descriptions
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case or snake_case
$.paths
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries should start with the provider name
$.paths[*][get,post,put,patch,delete]
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
parameter-description-required
Path and query parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-example-recommended
Parameters should have example values
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have a 2xx success response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-description-recommended
Component schemas should have descriptions
$.components.schemas[*]
info
schema-property-description-recommended
Schema properties should have descriptions
$.components.schemas[*].properties[*]
error
get-no-request-body
GET operations must not have request bodies
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have request bodies
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty
$..description