Amazon Simple Workflow Service · API Governance Rules

Amazon Simple Workflow Service API Rules

Spectral linting rules defining API design standards and conventions for Amazon Simple Workflow Service.

9 Rules error 4 warn 5
View Rules File View on GitHub

Rule Categories

info operation parameter response security

Rules

error
info-title-required
Info title must be present.
$.info
warn
info-description-required
Info description must be present.
$.info
error
operation-summary-required
Every operation must have a summary.
$.paths[*][*]
warn
operation-summary-prefix
Operation summaries must start with 'Amazon SWF'.
$.paths[*][*].summary
error
operation-operationId-required
Every operation must have an operationId.
$.paths[*][*]
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][*]
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][*].parameters[*]
error
response-success-required
Every operation must have at least one 2xx response.
$.paths[*][*].responses
warn
security-schemes-defined
Security schemes must be defined.
$.components

Spectral Ruleset

Raw ↑ 
extends: spectral:oas
rules:
  # INFO / METADATA
  info-title-required:
    description: Info title must be present.
    severity: error
    given: "$.info"
    then:
      field: title
      function: truthy

  info-description-required:
    description: Info description must be present.
    severity: warn
    given: "$.info"
    then:
      field: description
      function: truthy

  # OPERATIONS
  operation-summary-required:
    description: Every operation must have a summary.
    severity: error
    given: "$.paths[*][*]"
    then:
      field: summary
      function: truthy

  operation-summary-prefix:
    description: Operation summaries must start with 'Amazon SWF'.
    severity: warn
    given: "$.paths[*][*].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Amazon SWF"

  operation-operationId-required:
    description: Every operation must have an operationId.
    severity: error
    given: "$.paths[*][*]"
    then:
      field: operationId
      function: truthy

  operation-tags-required:
    description: Every operation must have at least one tag.
    severity: warn
    given: "$.paths[*][*]"
    then:
      field: tags
      function: truthy

  # PARAMETERS
  parameter-description-required:
    description: Every parameter must have a description.
    severity: warn
    given: "$.paths[*][*].parameters[*]"
    then:
      field: description
      function: truthy

  # RESPONSES
  response-success-required:
    description: Every operation must have at least one 2xx response.
    severity: error
    given: "$.paths[*][*].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          minProperties: 1

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