Amazon IoT Core · API Governance Rules
Amazon IoT Core API Rules
Spectral linting rules defining API design standards and conventions for Amazon IoT Core.
14 Rules
error 8
warn 5
info 1
Rule Categories
get
info
no
openapi
operation
response
schema
security
servers
Rules
error
info-title-required
Info title must be present.
$.info
error
info-version-required
API version must be specified.
$.info
error
openapi-version-3
Must use OpenAPI 3.x.
$
error
servers-defined
At least one server must be defined.
$
error
servers-https-only
All server URLs must use HTTPS.
$.servers[*]
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-prefix
Operation summaries must start with 'Amazon IoT Core'.
$.paths[*][get,post,put,delete,patch]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,delete,patch]
warn
response-description-required
Every response must have a description.
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-type-defined
Schemas should define an explicit type.
$.components.schemas[*]
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description
warn
security-schemes-defined
Security schemes should be defined in components.
$.components