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.

29 Rules error 10 warn 15 info 4
View Rules File View on GitHub

Rule Categories

delete error examples get info no openapi operation operationid parameter path query 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[*]
warn
path-params-casing
Path parameters should be camelCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
query-params-casing
Query parameters should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
operationid-casing
Operation IDs should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be camelCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
error-schema-defined
A shared error schema (JobError) should be defined for error payloads.
$.components.schemas

Spectral Ruleset

Raw ↑ 
# amazon-iam-access-analyzer — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 50% of servers already https (warn)
#   - path-params-casing: camel @ 94% (n=18)
#   - query-params-casing: camel @ 96% (n=28)
#   - operationid-casing: pascal @ 100% (n=28)
#   - schema-names-casing: pascal @ 100% (n=218)
#   - schema-properties-casing: camel @ 62% (n=269)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: JobError
#   - pagination params observed: ['maxResults', 'nextToken']
#   - merge: kept 23 existing, added 6 measured, upgraded 0
#   - added: path-params-casing, query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, error-schema-defined
extends:
  - spectral:oas
rules:
  info-title-required:
    description: Info title must be present and non-empty.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  info-description-required:
    description: Info description must be present and have at least 20 characters.
    severity: warn
    given: $.info
    then:
      field: description
      function: minLength
      functionOptions:
        min: 20
  info-version-required:
    description: API version must be specified in info.version.
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  openapi-version-3:
    description: Must use OpenAPI 3.x specification.
    severity: error
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: ^3\.
  servers-defined:
    description: At least one server must be defined.
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https-only:
    description: All server URLs must use HTTPS.
    severity: error
    given: $.servers[*]
    then:
      field: url
      function: pattern
      functionOptions:
        match: ^https://
  operation-summary-required:
    description: Every operation must have a non-empty summary.
    severity: error
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Every operation summary must start with 'Amazon IAM Access Analyzer'.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: summary
      function: pattern
      functionOptions:
        match: ^Amazon IAM Access Analyzer
  operation-description-required:
    description: Every operation must have a description.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: description
      function: truthy
  operation-id-required:
    description: Every operation must have an operationId.
    severity: error
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: operationId
      function: truthy
  operation-id-camel-case:
    description: operationId should use PascalCase (e.g. ListAnalyzers, CreateAnalyzer).
    severity: warn
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: operationId
      function: pattern
      functionOptions:
        match: ^[A-Z][a-zA-Z0-9]*$
  operation-tags-required:
    description: Every operation must have at least one tag.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch,head,options]
    then:
      field: tags
      function: truthy
  parameter-description-required:
    description: Every parameter must have a description.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch,head,options].parameters[*]
    then:
      field: description
      function: truthy
  parameter-schema-required:
    description: Every parameter must define a schema.
    severity: error
    given: $.paths[*][get,post,put,delete,patch,head,options].parameters[*]
    then:
      field: schema
      function: truthy
  response-success-required:
    description: Every operation must define at least one 2xx success response.
    severity: error
    given: $.paths[*][get,post,put,delete,patch,head,options].responses
    then:
      function: schema
      functionOptions:
        schema:
          minProperties: 1
  response-description-required:
    description: Every response must have a description.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch,head,options].responses[*]
    then:
      field: description
      function: truthy
  schema-description-required:
    description: Top-level component schemas should have a description.
    severity: info
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  schema-type-defined:
    description: Schemas should define an explicit type.
    severity: info
    given: $.components.schemas[*]
    then:
      field: type
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined in components if security is used.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  get-no-request-body:
    description: GET operations must not have a request body.
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy
  delete-no-request-body:
    description: DELETE operations should not have a request body.
    severity: warn
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy
  examples-encouraged:
    description: Schema properties should include example values.
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: example
      function: truthy
  path-params-casing:
    description: Path parameters should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*].parameters[?(@.in=='path')].name
    then:
      function: casing
      functionOptions:
        type: camel
  query-params-casing:
    description: Query parameters should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: camel
  operationid-casing:
    description: Operation IDs should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: pascal
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  schema-properties-casing:
    description: Schema properties should be camelCase (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: camel
  error-schema-defined:
    description: A shared error schema (JobError) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: JobError
      function: truthy