Amazon Data Exchange · API Governance Rules
Amazon Data Exchange API Rules
Spectral linting rules defining API design standards and conventions for Amazon Data Exchange.
30 Rules
error 13
warn 10
info 7
Rule Categories
arn
create
delete
get
info
list
no
openapi
operation
paths
request
response
schema
security
servers
tag
tags
update
Rules
warn
info-title-prefix
API title must start with "AWS Data Exchange"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
warn
info-contact-required
Info object should have a contact
$.info
error
openapi-version-3x
Must use OpenAPI 3.x
$
error
servers-defined
Servers array must be defined
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
warn
paths-versioned
AWS Data Exchange API paths should include version prefix /v1/
$.paths[*]~
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-description-required
All operations must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
All operations 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
All operations must have tags
$.paths[*][get,post,put,patch,delete]
info
create-uses-post
Create operations should use POST method
$.paths[*][post].operationId
info
get-uses-get-method
Get/List operations should use GET method
$.paths[*][get].operationId
info
update-uses-patch
Update operations should use PATCH method
$.paths[*][patch].operationId
info
delete-uses-delete-method
Delete/Cancel operations should use DELETE method
$.paths[*][delete].operationId
warn
tags-defined
Tags array should be defined globally
$
warn
tag-description-required
Each tag must have a description
$.tags[*]
warn
request-body-json-content
POST/PATCH request bodies should support application/json
$.paths[*][post,patch].requestBody.content
error
response-success-required
All operations must have at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description
$.paths[*][*].responses[*]
warn
response-error-has-message
Error response schemas should include a message field
$.components.schemas.Error.properties
warn
schema-description-required
Top-level schemas should have a description
$.components.schemas[*]
info
list-response-has-next-token
List operations should support pagination via NextToken
$.paths[*][get].responses.200.content.application/json.schema.properties
info
arn-field-documented
ARN fields should have descriptions documenting them as unique identifiers
$.components.schemas[*].properties.Arn.description
error
security-schemes-defined
Security schemes must be defined
$.components
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operation-examples-encouraged
Operations should have examples in request/response bodies
$.paths[*][*].requestBody.content[*]