American Express Global Business Travel · API Governance Rules
American Express Global Business Travel API Rules
Spectral linting rules defining API design standards and conventions for American Express Global Business Travel.
46 Rules
error 33
warn 10
info 3
Generated by API Evangelist
Written by API Evangelist tooling for American Express Global Business Travel's APIs. It is a starting point, not a ruleset American Express Global Business Travel publishes or enforces.
Rule Categories
info
oauthflow
operation
parameter
path
property
requestbody
response
schema
securityscheme
server
servers
tag
Rules
error
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-tags
Every operation is tagged (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
warn
operation-has-success-response
Every operation declares a 2xx response (measured: 96% of this contract)
$.paths[*][get,post,put,patch,delete].responses
info
operation-declares-4xx
Every operation declares at least one 4xx response (measured: 84% of this contract)
$.paths[*][get,post,put,patch,delete].responses
warn
path-segment-casing-kebab
Path segments are kebab case (measured: 92% of this contract)
$.paths[*]~
error
path-no-trailing-slash
Paths carry no trailing slash (measured: 100% of this contract)
$.paths[*]~
error
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 100% of this contract)
$.paths[*]~
error
servers-https
Servers are https (measured: 100% of this contract)
$.servers[*].url
info
property-name-casing-snake
Schema property names are snake case (measured: 82% of this contract)
$.components.schemas[*].properties[*]~
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
warn
info-title-min-length
Info.title runs at least 18 characters (measured: 96% of this contract)
$.info.title
error
info-description-min-length
Info.description runs at least 33 characters (measured: 100% of this contract)
$.info.description
error
info-version-present
Info declares version (measured: 100% of this contract)
$.info
error
info-version-semver
info.version is numeric (measured: 100% of this contract)
$.info.version
error
server-url-present
Server declares url (measured: 100% of this contract)
$.servers[*]
error
server-url-https
Server.url is https (measured: 100% of this contract)
$.servers[*].url
error
server-description-present
Server declares description (measured: 100% of this contract)
$.servers[*]
error
server-description-min-length
Server.description runs at least 10 characters (measured: 100% of this contract)
$.servers[*].description
error
tag-name-present
Tag declares name (measured: 100% of this contract)
$.tags[*]
error
tag-description-min-length
Tag.description runs at least 27 characters (measured: 100% of this contract)
$.tags[*].description
error
operation-tags-present
Operation declares tags (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
warn
operation-summary-min-length
Operation.summary runs at least 8 characters (measured: 95% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].summary
error
operation-description-min-length
Operation.description runs at least 2 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].description
error
operation-operationid-present
Operation declares operationId (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-responses-present
Operation declares responses (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
parameter-name-present
Parameter declares name (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
info
parameter-name-casing-camel
Parameter.name is camel case (measured: 82% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].name
error
parameter-in-present
Parameter declares in (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-values
Parameter.in is one of header, path, query (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
warn
parameter-description-min-length
Parameter.description runs at least 7 characters (measured: 95% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
error
parameter-required-present
Parameter declares required (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-schema-present
Parameter declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
requestbody-content-present
RequestBody declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
warn
requestbody-required-present
RequestBody declares required (measured: 96% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
error
response-description-present
Response declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
warn
response-description-min-length
Response.description runs at least 10 characters (measured: 95% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].description
warn
schema-type-values
Schema.type is one of object (measured: 99% of this contract)
$.components.schemas[*].type
warn
schema-description-min-length
Schema.description runs at least 16 characters (measured: 95% of this contract)
$.components.schemas[*].description
warn
schema-properties-present
Schema declares properties (measured: 97% of this contract)
$.components.schemas[*]
error
securityscheme-type-present
SecurityScheme declares type (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-type-values
SecurityScheme.type is one of oauth2 (measured: 100% of this contract)
$.components.securitySchemes[*].type
error
securityscheme-flows-present
SecurityScheme declares flows (measured: 100% of this contract)
$.components.securitySchemes[*]
error
oauthflow-tokenurl-present
OAuthFlow declares tokenUrl (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*]
error
oauthflow-tokenurl-https
OAuthFlow.tokenUrl is https (measured: 100% of this contract)
$.components.securitySchemes[*].flows[*].tokenUrl
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.