Amazon Marketplace · API Governance Rules
Amazon Marketplace API Rules
Spectral linting rules defining API design standards and conventions for Amazon Marketplace.
18 Rules
error 7
warn 7
info 4
Rule Categories
examples
http
info
no
openapi
operation
parameter
paths
response
schema
security
servers
Rules
error
info-title-required
Info title must be present
$.info
warn
info-description-required
Info description must be present
$.info
error
info-version-required
API version must be defined
$.info
error
openapi-version
Must use OpenAPI 3.0.x
$
error
servers-required
Servers must be defined
$
warn
servers-https
Server URLs should use HTTPS
$.servers[*]
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
info
operation-summary-prefix
Operation summaries should start with "Amazon Marketplace"
$.paths[*][get,post,put,patch,delete].summary
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
info
schema-description
Top-level schemas should have descriptions
$.components.schemas[*]
error
security-schemes-required
Security schemes must be defined
$.components
error
http-get-no-body
GET operations should not have request bodies
$.paths[*].get
warn
no-empty-descriptions
Descriptions should not be empty strings
$..description
info
paths-kebab-case
Path segments should use kebab-case
$.paths
info
examples-encouraged
Schema properties should include examples
$.components.schemas[*].properties[*]