Amazon IAM · API Governance Rules
Amazon IAM API Rules
Spectral linting rules defining API design standards and conventions for Amazon IAM.
20 Rules
error 9
warn 8
info 3
Rule Categories
get
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 at least 20 characters.
$.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 IAM'.
$.paths[*][get,post,put,delete,patch]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,delete,patch]
warn
operation-id-pascal-case
operationId should use PascalCase.
$.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
parameter-description-required
Every parameter must have a description.
$.paths[*][get,post,put,delete,patch].parameters[*]
error
response-success-required
Every operation must define a 2xx response.
$.paths[*][get,post,put,delete,patch].responses
warn
response-description-required
Every response must have a description.
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-description-required
Top-level schemas should have a description.
$.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
info
paths-kebab-case
Path segments should use kebab-case.
$.paths
info
schema-type-defined
Schemas should define an explicit type.
$.components.schemas[*]