Amadeus Media · API Governance Rules
Amadeus Media API Rules
Spectral linting rules defining API design standards and conventions for Amadeus Media.
31 Rules
error 17
warn 10
info 4
Rule Categories
delete
get
info
openapi
operation
parameter
paths
response
schema
security
servers
Rules
error
info-title-required
API title must be present.
$.info
warn
info-title-prefix
API title must start with "Amadeus".
$.info.title
error
info-description-required
API must have a description.
$.info
error
info-version-required
API version must be present.
$.info
error
openapi-version-3
APIs must use OpenAPI 3.x.
$
error
servers-required
At least one server must be defined.
$
error
servers-https
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-description
Each server should have a description.
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case.
$.paths
error
paths-no-trailing-slash
Paths must not have trailing slashes.
$.paths
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-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]
warn
operation-id-camel-case
operationId must use camelCase.
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
info
operation-microcks-extension
Operations should include x-microcks-operation for mock compatibility.
$.paths[*][get,post,put,patch,delete]
error
parameter-description-required
Every parameter must have a description.
$.paths[*][*].parameters[*]
error
parameter-schema-required
Every parameter must have a schema.
$.paths[*][*].parameters[*]
info
parameter-snake-case
Parameter names should use snake_case or camelCase.
$.paths[*][*].parameters[*].name
error
response-success-required
Every operation must define at least one 2xx response.
$.paths[*][get,post,put,patch,delete].responses
info
response-400-recommended
Operations should define a 400 error response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-recommended
Operations should define a 401 error response.
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description.
$.paths[*][*].responses[*]
warn
schema-description-recommended
Top-level schemas should have descriptions.
$.components.schemas[*]
warn
schema-property-type-required
Schema properties should define a type.
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined in components.
$.components
warn
security-bearer-described
BearerAuth security scheme should have a description.
$.components.securitySchemes.BearerAuth
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
info
response-json-content
Responses should use application/vnd.amadeus+json or application/json content type.
$.paths[*][*].responses[*].content