Amazon Monitron · API Governance Rules
Amazon Monitron API Rules
Spectral linting rules defining API design standards and conventions for Amazon Monitron.
20 Rules
error 9
warn 7
info 4
Rule Categories
get
info
openapi
operation
parameter
paths
response
schema
security
servers
tag
Rules
error
info-title-required
Info title must be present and non-empty.
$.info
warn
info-description-required
Info description must be present.
$.info
error
info-version-required
Info version must be present.
$.info
error
openapi-version-3
OpenAPI version must be 3.x.
$
error
servers-required
Servers must be defined.
$
error
servers-https
All server URLs must use HTTPS.
$.servers[*]
warn
paths-no-trailing-slash
Paths must not have trailing slashes.
$.paths[*]~
error
operation-operationId-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-company-prefix
Operation summaries must start with 'Amazon Monitron'.
$.paths[*][get,post,put,patch,delete].summary
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
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-description-required
All responses must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
info
schema-property-type-required
Schema properties should define a type.
$.components.schemas[*].properties[*]
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
info
tag-description-required
All tags should have a description.
$.tags[*]
info
schema-description-required
Top-level schemas should have descriptions.
$.components.schemas[*]
info
operation-id-camel-case
OperationId should use camelCase.
$.paths[*][get,post,put,patch,delete].operationId