American Airlines · API Governance Rules
American Airlines API Rules
Spectral linting rules defining API design standards and conventions for American Airlines.
12 Rules
error 8
warn 3
info 1
Rule Categories
get
info
operation
parameter
paths
response
schema
servers
Rules
warn
info-title-prefix
API title must start with "American Airlines"
$.info.title
error
info-description-required
API must have a description
$.info
error
servers-defined
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Operations must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
response-success-required
Operations must have a success response
$.paths[*][get,post,put,patch,delete].responses
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
info
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
warn
schema-description-required
Component schemas should have descriptions
$.components.schemas[*]
warn
parameter-description-required
Parameters should have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]