Amadeus · API Governance Rules
Amadeus API Rules
Spectral linting rules defining API design standards and conventions for Amadeus.
15 Rules
error 8
warn 5
info 2
Rule Categories
amadeus
Rules
error
amadeus-info-title-required
API info must have a title field.
$.info
error
amadeus-info-description-required
API info must have a description.
$.info
error
amadeus-info-version-required
API info must have a version.
$.info
error
amadeus-operation-summary-required
All operations must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
amadeus-operation-description-required
All operations should have a description.
$.paths[*][get,post,put,patch,delete]
error
amadeus-operation-tags-required
All operations must have at least one tag.
$.paths[*][get,post,put,patch,delete]
error
amadeus-operation-operationid-required
All operations must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
amadeus-parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
amadeus-response-200-required
All GET operations must have a 200 response.
$.paths[*].get
warn
amadeus-response-description-required
All responses must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
warn
amadeus-security-bearer-defined
API should define bearer security scheme.
$.components.securitySchemes
info
amadeus-schema-description
Schemas should have descriptions.
$.components.schemas[*]
warn
amadeus-paths-kebab-case
API paths should use kebab-case.
$.paths
info
amadeus-contact-required
API info should include contact information.
$.info
error
amadeus-servers-required
API must define at least one server.
$