BigPanda · API Governance Rules
BigPanda API Rules
Spectral linting rules defining API design standards and conventions for BigPanda.
23 Rules
error 8
warn 15
Rule Categories
bigpanda
Rules
error
bigpanda-info-title-prefix
API title must start with "BigPanda"
$.info.title
error
bigpanda-info-version-present
API info must have a version field
$.info
warn
bigpanda-info-contact-present
API info must include contact details
$.info
error
bigpanda-operation-summary-prefix
Operation summaries must start with "BigPanda"
$.paths[*][*].summary
warn
bigpanda-operation-id-camel-case
Operation IDs must be camelCase
$.paths[*][*].operationId
warn
bigpanda-operation-tags-present
Every operation must have at least one tag
$.paths[*][*]
warn
bigpanda-operation-description-present
Every operation must have a description
$.paths[*][*]
warn
bigpanda-path-no-trailing-slash
Paths must not end with a slash
$.paths
error
bigpanda-request-body-required
POST operations must have a request body
$.paths[*].post
error
bigpanda-response-success-present
Every operation must define a success response
$.paths[*][*].responses
warn
bigpanda-schema-title-present
All schemas must have a title
$.components.schemas[*]
warn
bigpanda-schema-description-present
All schemas must have a description
$.components.schemas[*]
warn
bigpanda-schema-properties-described
Schema properties must have descriptions
$.components.schemas[*].properties[*]
error
bigpanda-security-scheme-present
API must define at least one security scheme
$.components
warn
bigpanda-bearer-auth-used
Security scheme must be bearer auth
$.components.securitySchemes[*]
warn
bigpanda-operation-security-present
Operations must declare security
$.paths[*][get,post,put,patch,delete]
warn
bigpanda-tags-defined
All tags used in operations must be defined at top level
$.tags
error
bigpanda-servers-present
API must define servers
$
error
bigpanda-server-https
Server URL must use HTTPS
$.servers[*].url
warn
bigpanda-operation-examples-present
Responses with content should include examples
$.paths[*][*].responses[*].content[*]
warn
bigpanda-microcks-operation-present
Every operation must include x-microcks-operation extension
$.paths[*][*]
warn
bigpanda-alert-app-key-required
Alert requests must include app_key field
$.components.schemas.AlertRequest.required
warn
bigpanda-license-present
API info must include license
$.info