Amazon API Gateway · API Governance Rules

Amazon API Gateway API Rules

Spectral linting rules defining API design standards and conventions for Amazon API Gateway.

35 Rules error 17 warn 17 info 1
View Rules File View on GitHub

Rule Categories

deprecation info method no openapi operation parameter paths request response schema security servers tag

Rules

warn
info-title-prefix
API title must start with "Amazon API Gateway"
$.info.title
error
info-description-required
Info object must have a description with at least 20 characters
$.info
error
info-version-required
Info object must have a version
$.info
warn
info-contact-required
Info object should have contact information
$.info
error
openapi-version-3
All specs must use OpenAPI 3.x
$
error
servers-defined
Servers array must be defined and non-empty
$
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
warn
servers-description
Each server should have a description
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case (lowercase letters, numbers, hyphens)
$.paths[*]~
error
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-prefix
Operation summaries must start with "Amazon API Gateway"
$.paths[*][get,post,put,patch,delete,head,options].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-id-camel-case
OperationIds must use camelCase
$.paths[*][get,post,put,patch,delete,head,options].operationId
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
tag-global-defined
All tags used in operations should be defined in the global tags array
$
warn
tag-description
Global tags should have descriptions
$.tags[*]
error
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
error
parameter-schema-required
All parameters must have a schema with a type
$.paths[*][*].parameters[*]
warn
request-body-json-content
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
warn
request-body-description
Request bodies should have descriptions
$.paths[*][*].requestBody
error
response-success-required
Every operation must have at least one 2xx response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
All responses must have descriptions
$.paths[*][*].responses[*]
warn
response-401-on-secured
Secured operations should document 401 Unauthorized response
$.paths[*][get,post,put,patch,delete]
warn
schema-description
Top-level component schemas should have descriptions
$.components.schemas[*]
warn
schema-type-required
Schema objects should define a type
$.components.schemas[*]
info
schema-property-snake-case
Schema property names should use snake_case
$.components.schemas[*].properties[*]~
error
security-schemes-defined
Security schemes must be defined in components
$
warn
security-sigv4-scheme
AWS SigV4 security scheme should be defined
$.components.securitySchemes
error
method-get-no-body
GET operations must not have a request body
$.paths[*].get
warn
method-delete-no-body
DELETE operations should not have a request body
$.paths[*].delete
warn
method-post-has-body
POST operations creating resources should have a request body
$.paths[*].post
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
warn
deprecation-documented
Deprecated operations should have a description explaining the deprecation
$.paths[*][*][?(@.deprecated == true)]

Spectral Ruleset

Raw ↑ 
rules:

  # INFO / METADATA
  info-title-prefix:
    description: API title must start with "Amazon API Gateway"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: "^Amazon API Gateway"

  info-description-required:
    description: Info object must have a description with at least 20 characters
    severity: error
    given: $.info
    then:
      - field: description
        function: truthy
      - field: description
        function: minLength
        functionOptions:
          value: 20

  info-version-required:
    description: Info object must have a version
    severity: error
    given: $.info
    then:
      field: version
      function: truthy

  info-contact-required:
    description: Info object should have contact information
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy

  # OPENAPI VERSION
  openapi-version-3:
    description: All specs must use OpenAPI 3.x
    severity: error
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\."

  # SERVERS
  servers-defined:
    description: Servers array must be defined and non-empty
    severity: error
    given: $
    then:
      field: servers
      function: truthy

  servers-https:
    description: All server URLs must use HTTPS
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  servers-description:
    description: Each server should have a description
    severity: warn
    given: $.servers[*]
    then:
      field: description
      function: truthy

  # PATHS - NAMING CONVENTIONS
  paths-kebab-case:
    description: Path segments must use kebab-case (lowercase letters, numbers, hyphens)
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: "^(/[a-z0-9{}_-]+)+$"

  paths-no-trailing-slash:
    description: Paths must not have trailing slashes
    severity: error
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: "/$"

  # OPERATIONS
  operation-summary-required:
    description: Every operation must have a summary
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: summary
      function: truthy

  operation-summary-prefix:
    description: Operation summaries must start with "Amazon API Gateway"
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options].summary
    then:
      function: pattern
      functionOptions:
        match: "^Amazon API Gateway"

  operation-description-required:
    description: Every operation must have a description
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: description
      function: truthy

  operation-id-required:
    description: Every operation must have an operationId
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: operationId
      function: truthy

  operation-id-camel-case:
    description: OperationIds must use camelCase
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options].operationId
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"

  operation-tags-required:
    description: Every operation must have at least one tag
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: tags
      function: truthy

  # TAGS
  tag-global-defined:
    description: All tags used in operations should be defined in the global tags array
    severity: warn
    given: $
    then:
      field: tags
      function: truthy

  tag-description:
    description: Global tags should have descriptions
    severity: warn
    given: $.tags[*]
    then:
      field: description
      function: truthy

  # PARAMETERS
  parameter-description-required:
    description: All parameters must have descriptions
    severity: error
    given: $.paths[*][*].parameters[*]
    then:
      field: description
      function: truthy

  parameter-schema-required:
    description: All parameters must have a schema with a type
    severity: error
    given: $.paths[*][*].parameters[*]
    then:
      field: schema
      function: truthy

  # REQUEST BODIES
  request-body-json-content:
    description: Request bodies should use application/json content type
    severity: warn
    given: $.paths[*][post,put,patch].requestBody.content
    then:
      field: application/json
      function: truthy

  request-body-description:
    description: Request bodies should have descriptions
    severity: warn
    given: $.paths[*][*].requestBody
    then:
      field: description
      function: truthy

  # RESPONSES
  response-success-required:
    description: Every operation must have at least one 2xx response
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: responses
      function: truthy

  response-description-required:
    description: All responses must have descriptions
    severity: error
    given: $.paths[*][*].responses[*]
    then:
      field: description
      function: truthy

  response-401-on-secured:
    description: Secured operations should document 401 Unauthorized response
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: responses.401
      function: truthy

  # SCHEMAS - PROPERTY NAMING
  schema-description:
    description: Top-level component schemas should have descriptions
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy

  schema-type-required:
    description: Schema objects should define a type
    severity: warn
    given: $.components.schemas[*]
    then:
      field: type
      function: truthy

  schema-property-snake-case:
    description: Schema property names should use snake_case
    severity: info
    given: $.components.schemas[*].properties[*]~
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-z0-9_]*$"

  # SECURITY
  security-schemes-defined:
    description: Security schemes must be defined in components
    severity: error
    given: $
    then:
      field: components.securitySchemes
      function: truthy

  security-sigv4-scheme:
    description: AWS SigV4 security scheme should be defined
    severity: warn
    given: $.components.securitySchemes
    then:
      field: sigv4
      function: truthy

  # HTTP METHOD CONVENTIONS
  method-get-no-body:
    description: GET operations must not have a request body
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy

  method-delete-no-body:
    description: DELETE operations should not have a request body
    severity: warn
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy

  method-post-has-body:
    description: POST operations creating resources should have a request body
    severity: warn
    given: $.paths[*].post
    then:
      field: requestBody
      function: truthy

  # GENERAL QUALITY
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: error
    given: $..description
    then:
      function: pattern
      functionOptions:
        match: ".+"

  deprecation-documented:
    description: Deprecated operations should have a description explaining the deprecation
    severity: warn
    given: $.paths[*][*][?(@.deprecated == true)]
    then:
      field: description
      function: truthy