Amazon App Runner · API Governance Rules

Amazon App Runner API Rules

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

3 Rules error 3
View Rules File View on GitHub

Rule Categories

amazon

Rules

error
amazon-app-runner-info-title
API must have a title.
$.info
error
amazon-app-runner-operation-summary
Operations must have summaries.
$.paths[*][get,post,put,patch,delete]
error
amazon-app-runner-operation-id
Operations must have operationIds.
$.paths[*][get,post,put,patch,delete]

Spectral Ruleset

Raw ↑ 
extends:
- - spectral:oas
  - all
rules:
  amazon-app-runner-info-title:
    description: API must have a title.
    message: Info must include title.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  amazon-app-runner-operation-summary:
    description: Operations must have summaries.
    message: Operation must include summary.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
  amazon-app-runner-operation-id:
    description: Operations must have operationIds.
    message: Operation must include operationId.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy