Acadia · API Governance Rules
Acadia API Rules
Spectral linting rules defining API design standards and conventions for Acadia.
25 Rules
error 13
warn 8
info 4
Rule Categories
delete
get
info
openapi
operation
parameter
paths
response
schema
security
servers
Rules
error
info-title-acadia-prefix
Info title must start with "Acadia"
$.info
error
info-description-required
Info description must be present
$.info
error
info-version-required
Info version must be present
$.info
error
openapi-version-3
Must use OpenAPI 3.0.x
$
error
servers-https-required
Server URLs must use HTTPS
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case
$.paths
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
warn
operation-summary-prefix
Operation summaries must start with "Acadia"
$.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]
warn
operation-id-camel-case
operationId must use camelCase
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
error
parameter-description-required
Parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-pagination-page
List endpoints should support page parameter
$.paths[*].get.parameters[?(@.name == "page")]
info
parameter-pagination-limit
List endpoints should support limit parameter
$.paths[*].get.parameters[?(@.name == "limit")]
error
response-success-required
Every operation must have a 2xx success response
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-required
Protected operations should document 401 response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-description-required
Component schemas must have descriptions
$.components.schemas[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
info
schema-property-example
Schema properties should have example values
$.components.schemas[*].properties[*]
error
security-schemes-required
Security schemes must be defined
$
warn
security-bearer-jwt
Acadia uses Bearer JWT authentication
$.components.securitySchemes[*][?(@.type == "http")]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-returns-200-or-204
DELETE operations should return 200 or 204
$.paths[*].delete.responses