Amazon DataZone · API Governance Rules
Amazon DataZone API Rules
Spectral linting rules defining API design standards and conventions for Amazon DataZone.
20 Rules
error 13
warn 5
info 2
Rule Categories
info
list
no
openapi
operation
paths
response
schema
security
servers
tags
Rules
warn
info-title-prefix
API title must reference "DataZone"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.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
DataZone API paths should include version prefix /v2/
$.paths[*]~
info
paths-domain-scoped
DataZone resources should be scoped under a domain
$.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]
warn
tags-defined
Tags array should be defined globally
$
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
schema-description-required
Top-level schemas should have a description
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined
$.components
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
list-response-has-next-token
List/search operations should support pagination via nextToken
$.paths[*][get].responses.200.content.application/json.schema.properties