Amazon Cognito · API Governance Rules

Amazon Cognito API Rules

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

16 Rules error 11 warn 5
View Rules File View on GitHub

Rule Categories

info method no openapi operation response schema security servers

Rules

warn
info-title-prefix
API title must start with "Amazon Cognito"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
error
openapi-version-3
All specs must use OpenAPI 3.x
$
error
servers-defined
Servers array must be defined
$
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries must start with "Amazon Cognito"
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-id-pascal-case
OperationIds should use PascalCase
$.paths[*][get,post,put,patch,delete].operationId
error
response-description-required
All responses must have descriptions
$.paths[*][*].responses[*]
warn
schema-description
Component schemas should have descriptions
$.components.schemas[*]
warn
security-schemes-defined
Security schemes should be defined
$
error
method-get-no-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty
$..description

Spectral Ruleset

Raw ↑ 
rules:

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

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

  info-version-required:
    description: Info object must have a version
    severity: error
    given: $.info
    then:
      field: version
      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
    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://"

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

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

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

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

  operation-id-pascal-case:
    description: OperationIds should use PascalCase
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z][a-zA-Z0-9]*$"

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

  # SCHEMAS
  schema-description:
    description: Component schemas should have descriptions
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy

  # SECURITY
  security-schemes-defined:
    description: Security schemes should be defined
    severity: warn
    given: $
    then:
      field: components.securitySchemes
      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

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