Amazon IAM Access Analyzer · API Governance Rules
Amazon IAM Access Analyzer API Rules
Spectral linting rules defining API design standards and conventions for Amazon IAM Access Analyzer.
23 Rules
error 10
warn 10
info 3
Rule Categories
delete
examples
get
info
no
openapi
operation
parameter
response
schema
security
servers
Rules
error
info-title-required
Info title must be present and non-empty.
$.info
warn
info-description-required
Info description must be present and have at least 20 characters.
$.info
error
info-version-required
API version must be specified in info.version.
$.info
error
openapi-version-3
Must use OpenAPI 3.x specification.
$
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 non-empty summary.
$.paths[*][get,post,put,delete,patch,head,options]
warn
operation-summary-prefix
Every operation summary must start with 'Amazon IAM Access Analyzer'.
$.paths[*][get,post,put,delete,patch,head,options]
warn
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,delete,patch,head,options]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,delete,patch,head,options]
warn
operation-id-camel-case
operationId should use PascalCase (e.g. ListAnalyzers, CreateAnalyzer).
$.paths[*][get,post,put,delete,patch,head,options]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,delete,patch,head,options]
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][get,post,put,delete,patch,head,options].parameters[*]
error
parameter-schema-required
Every parameter must define a schema.
$.paths[*][get,post,put,delete,patch,head,options].parameters[*]
error
response-success-required
Every operation must define at least one 2xx success response.
$.paths[*][get,post,put,delete,patch,head,options].responses
warn
response-description-required
Every response must have a description.
$.paths[*][get,post,put,delete,patch,head,options].responses[*]
info
schema-description-required
Top-level component schemas should have a description.
$.components.schemas[*]
info
schema-type-defined
Schemas should define an explicit type.
$.components.schemas[*]
warn
security-schemes-defined
Security schemes must be defined in components if security is used.
$.components
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description
info
examples-encouraged
Schema properties should include example values.
$.components.schemas[*].properties[*]