Amazon CloudTrail · API Governance Rules
Amazon CloudTrail API Rules
Spectral linting rules defining API design standards and conventions for Amazon CloudTrail.
19 Rules
error 12
warn 6
info 1
Rule Categories
get
info
microcks
no
operation
parameter
response
schema
security
servers
Rules
error
info-title-prefix
API title must start with "Amazon CloudTrail"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
API must have a version
$.info
error
servers-required
API must define at least one server
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationId-pascal-case
operationId must use PascalCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries must start with "Amazon CloudTrail"
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-description-required
All response codes must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-500-required
Operations should document 500 internal server error
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty
$..description
info
microcks-operation-present
Operations should have x-microcks-operation extension
$.paths[*][get,post,put,patch,delete]