AWS X-Ray · API Governance Rules

AWS X-Ray API Rules

Spectral linting rules defining API design standards and conventions for AWS X-Ray.

5 Rules error 3 warn 1 info 1
View Rules File View on GitHub

Rule Categories

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]