Amazon DevOps Guru · API Governance Rules

Amazon DevOps Guru API Rules

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

17 Rules error 11 warn 4 info 2
View Rules File View on GitHub

Rule Categories

external get info no openapi operation parameter response schema servers

Rules

warn
info-title-prefix
API title should include "DevOps Guru"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-description-required
All operations must have a description
$.paths[*][get,post,put,delete,patch]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
All parameters must have a description
$.paths[*][get,post,put,delete,patch].parameters[*]
error
response-success-required
Operations must have at least one 2xx response
$.paths[*][get,post,put,delete,patch].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
external-docs-encouraged
API should reference external documentation
$

Spectral Ruleset

Raw ↑ 
rules:
  # INFO / METADATA
  info-title-prefix:
    description: API title should include "DevOps Guru"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: "DevOps Guru"

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

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

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

  # SERVERS
  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[*].url
    then:
      function: pattern
      functionOptions:
        match: "^https://"

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

  operation-description-required:
    description: All operations must have a description
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: description
      function: truthy

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

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

  # PARAMETERS
  parameter-description-required:
    description: All parameters must have a description
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].parameters[*]
    then:
      field: description
      function: truthy

  # RESPONSES
  response-success-required:
    description: Operations must have at least one 2xx response
    severity: error
    given: $.paths[*][get,post,put,delete,patch].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ['200']
            - required: ['202']
            - required: ['204']

  response-description-required:
    description: All responses must have a description
    severity: error
    given: $.paths[*][get,post,put,delete,patch].responses[*]
    then:
      field: description
      function: truthy

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

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

  # GENERAL QUALITY
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: error
    given: $..description
    then:
      function: truthy

  external-docs-encouraged:
    description: API should reference external documentation
    severity: info
    given: $
    then:
      field: externalDocs
      function: truthy