BizAPI · API Governance Rules
BizAPI API Rules
Spectral linting rules defining API design standards and conventions for BizAPI.
33 Rules
error 13
warn 15
info 5
Rule Categories
examples
get
info
no
openapi
operation
parameter
paths
post
request
response
schema
security
servers
tags
Rules
warn
info-title-prefix
API title must start with "BizAPI"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
warn
info-contact-required
Info object should have contact information
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments must use kebab-case or lowercase
$.paths[*]~
warn
paths-no-trailing-slash
Paths must 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 must start with "BizAPI"
$.paths[*][get,post,put,patch,delete].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 must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,options,head]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
Every parameter must define a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
info
request-body-description
Request bodies should have a description
$.paths[*][post,put,patch].requestBody
warn
request-body-json
Request bodies must support application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must define at least one 2xx response
$.paths[*][get,post,put,patch,delete]
warn
response-401-defined
Operations using authentication should define a 401 response
$.paths[*][post]
info
response-429-defined
Operations should define a 429 rate-limit response
$.paths[*][post]
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-property-snake-case
Schema property names must use snake_case
$.components.schemas[*].properties[*]~
warn
schema-description-required
Top-level schemas must have a description
$.components.schemas[*]
info
schema-properties-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
error
security-schemes-defined
At least one security scheme must be defined in components
$.components
warn
security-global-defined
Global security must be defined
$
warn
post-has-request-body
POST operations should have a request body
$.paths[*].post
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
examples-encouraged
Schema properties should have examples
$.components.schemas[*].properties[*]
info
tags-global-defined
Global tags array should be defined
$