Amadeus Reservations · API Governance Rules
Amadeus Reservations API Rules
Spectral linting rules defining API design standards and conventions for Amadeus Reservations.
20 Rules
error 11
warn 7
info 2
Rule Categories
delete
get
info
operation
parameter
post
response
schema
security
servers
Rules
error
info-title-required
API title must be present.
$.info
warn
info-title-amadeus-prefix
API title must reference Amadeus.
$.info.title
error
info-description-required
API must have a description.
$.info
error
info-version-required
API version must be present.
$.info
error
servers-required
At least one server must be defined.
$
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
warn
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete]
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-success-required
Every operation must define at least one 2xx response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-booking
Booking operations should define a 401 response.
$.paths[*][post].responses
error
response-description-required
Every response must have a description.
$.paths[*][*].responses[*]
info
schema-description-recommended
Top-level schemas should have descriptions.
$.components.schemas[*]
warn
security-schemes-recommended
Security schemes should be defined in components.
$.components
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
info
delete-returns-204
DELETE operations should return 204 No Content.
$.paths[*].delete.responses
warn
post-has-request-body
POST operations for booking creation should have a request body.
$.paths[*].post