AWS X-Ray · API Governance Rules
AWS X-Ray API Rules
Spectral linting rules defining API design standards and conventions for AWS X-Ray.
12 Rules
error 4
warn 7
info 1
Rule Categories
no
operationid
schema
security
servers
xray
Rules
warn
xray-operation-summary
All operations must have a summary starting with "AWS X-Ray"
$.paths[*][get,post,put,delete,patch]
error
xray-operation-id
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
error
xray-info-title
Info object must have a title
$.info
error
xray-response-description
All responses must have a description
$.paths[*][*].responses[*]
info
xray-microcks-annotation
Operations should have x-microcks-operation annotation
$.paths[*][get,post,put,delete,patch]
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the amazonaws.com domain.
$.servers[*].url
warn
operationid-casing
Operation IDs should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be PascalCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description