Abacus · API Governance Rules

Abacus API Rules

Spectral linting rules defining API design standards and conventions for Abacus.

39 Rules error 13 warn 19 info 7
View Rules File View on GitHub

Rule Categories

delete examples get info microcks no openapi operation pagination parameter paths request response schema security servers tag

Rules

error
info-title-required
API info must have a title
$.info
warn
info-title-prefix
API title should start with "Abacus"
$.info.title
error
info-description-required
API info must have a description
$.info
error
info-version-required
API info must have a version
$.info
warn
info-contact-required
API info should have contact information
$.info
warn
openapi-version-3
Should use OpenAPI 3.x
$
error
servers-defined
Servers must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
servers-description
Each server should have a description
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case or snake_case with underscores
$.paths[*]~
warn
paths-no-trailing-slash
Paths should not have trailing slashes
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-summary-prefix
Operation summaries should start with "Abacus"
$.paths[*][get,post,put,patch,delete,options,head].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete,options,head]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-id-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete,options,head].operationId
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,options,head]
warn
tag-global-defined
Tags used in operations should be defined at the global level
$.tags
info
tag-description
Global tags should have descriptions
$.tags[*]
warn
parameter-description-required
All parameters must have a description
$..parameters[*]
warn
parameter-snake-case
Parameter names should use snake_case
$.paths[*][*].parameters[*].name
info
request-body-content-json
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Operations must have at least one 2xx response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
All responses must have a description
$.paths[*][*].responses[*]
warn
response-401-for-auth
Endpoints should document 401 Unauthorized responses
$.paths[*][get,post,put,delete].responses
warn
response-404-for-resource-endpoints
Endpoints with path parameters should document 404 responses
$.paths[*][get,put,delete].responses
warn
schema-description-recommended
Top-level schemas should have descriptions
$.components.schemas[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
schema-property-snake-case
Schema property names should use snake_case
$.components.schemas[*].properties
error
security-schemes-defined
Security schemes should be defined in components
$.components.securitySchemes
warn
security-scheme-description
Security schemes should have descriptions
$.components.securitySchemes[*]
warn
security-global-defined
Global security should be defined
$
info
security-oauth2-scopes
OAuth2 scopes should be defined
$.components.securitySchemes[?(@.type == 'oauth2')]
error
get-no-request-body
GET operations should 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 should not be empty strings
$..description
info
examples-on-schemas
Schema properties should have examples for better DX
$.components.schemas[*].properties[*]
info
microcks-operation-extension
Operations should have x-microcks-operation for mock compatibility
$.paths[*][get,post,put,patch,delete]
info
pagination-params-standard
Paginated endpoints should use standard page/per_page parameters
$.paths[*].get.parameters[*].name