Appmixer · API Governance Rules
Appmixer API Rules
Spectral linting rules defining API design standards and conventions for Appmixer.
19 Rules
error 7
warn 11
info 1
Rule Categories
http
info
no
operation
parameter
paths
response
schema
security
servers
Rules
warn
info-title-appmixer-prefix
API title should start with "Appmixer"
$.info
error
info-version-required
API version must be specified
$.info
warn
info-description-required
API description must be present
$.info
error
servers-required
At least one server must be defined
$
warn
servers-https
Server URLs must use HTTPS
$.servers[*]
warn
security-bearer-auth
Appmixer APIs use Bearer JWT authentication
$.components.securitySchemes
warn
paths-kebab-case
Path segments must use kebab-case
$.paths
error
operation-summary-required
Every operation must have a summary
$.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]
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
operation-success-response-required
Every operation must have a 2xx response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-title-required
Component schemas should have a title
$.components.schemas[*]
info
schema-snake-case-properties
Schema property names should use camelCase
$.components.schemas[*].properties
error
http-get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description