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.

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

Rule Categories

info no operation operationid parameter query response schema security servers

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
warn
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
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
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# amazon-swf — 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)
#   - query-params-casing: camel @ 100% (n=14)
#   - operationid-casing: pascal @ 100% (n=37)
#   - schema-names-casing: pascal @ 100% (n=226)
#   - schema-properties-casing: camel @ 73% (n=593)
#   - security: global (root) — NOT emitting operation-security-required
#   - merge: kept 9 existing, added 6 measured, upgraded 0
#   - added: servers-https-only, query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, no-empty-descriptions
extends:
  - spectral:oas
rules:
  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
  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
  parameter-description-required:
    description: Every parameter must have a description.
    severity: warn
    given: $.paths[*][*].parameters[*]
    then:
      field: description
      function: truthy
  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-schemes-defined:
    description: Security schemes must be defined.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  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
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy