Archbee · API Governance Rules
Archbee API Rules
Spectral linting rules defining API design standards and conventions for Archbee.
19 Rules
error 12
warn 6
info 1
Rule Categories
delete
get
info
openapi
operation
parameter
response
schema
security
servers
Rules
error
info-title-archbee-prefix
API title must start with "Archbee"
$.info
warn
info-description-required
API must have a description
$.info
error
info-version-required
API must specify a version
$.info
error
openapi-version-3
Use OpenAPI 3.0.x
$
error
servers-defined
Server URLs must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-id-camel-case
OperationIds should use camelCase
$.paths[*][get,post,put,delete,patch]
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-prefix
Operation summaries should start with "Archbee"
$.paths[*][get,post,put,delete,patch]
error
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
All parameters must have a description
$.paths[*][*].parameters[*]
error
response-success-required
All operations must define a success response
$.paths[*][get,post,put,delete,patch].responses
warn
response-401-required
Secured operations should document 401 responses
$.paths[*][get,post,put,delete,patch].responses
error
response-description-required
All responses must have a description
$.paths[*][*].responses[*]
warn
schema-type-defined
Schema properties should define a type
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
info
delete-returns-204
DELETE operations should return 204
$.paths[*].delete.responses