Amadeus Solutions · API Governance Rules
Amadeus Solutions API Rules
Spectral linting rules defining API design standards and conventions for Amadeus Solutions.
15 Rules
error 10
warn 4
info 1
Rule Categories
get
info
operation
parameter
paths
response
schema
security
servers
Rules
error
info-title-required
API title must be present.
$.info
error
info-description-required
API must have a description.
$.info
error
info-version-required
API version must be present.
$.info
error
servers-https
Server URLs must use HTTPS.
$.servers[*].url
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-amadeus-prefix
Operation summaries must start with "Amadeus".
$.paths[*][get,post,put,patch,delete].summary
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
error
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[*][*].parameters[*]
error
response-description-required
Every response must have a description.
$.paths[*][*].responses[*]
warn
response-401-required
Operations should define a 401 response.
$.paths[*][get,post].responses
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
info
schema-description
Top-level schemas should have descriptions.
$.components.schemas[*]
warn
security-schemes-defined
Security schemes should be defined.
$.components
error
paths-no-trailing-slash
Paths must not have trailing slashes.
$.paths