Amazon CodeCatalyst · API Governance Rules

Amazon CodeCatalyst API Rules

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

15 Rules error 8 warn 6 info 1
View Rules File View on GitHub

Rule Categories

info no openapi operation parameter response schema servers

Rules

error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
warn
openapi-version-3
Must use OpenAPI 3.0.x
$.openapi
error
servers-defined
Servers 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,delete,patch]
warn
operation-summary-company-prefix
Operation summaries should start with Amazon CodeCatalyst
$.paths[*][get,post,put,delete,patch].summary
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][*].parameters[*]
error
response-success-required
Every operation must define at least one 2xx response
$.paths[*][get,post,put,delete,patch]
error
response-description-required
Every response must have a description
$.paths[*][*].responses[*]
warn
schema-type-required
Schema components should have a type
$.components.schemas[*]
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operation-microcks-operation
Operations should include x-microcks-operation
$.paths[*][get,post,put,delete,patch]

Spectral Ruleset

Raw ↑ 
extends: "spectral:oas"

rules:

  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-3:
    description: Must use OpenAPI 3.0.x
    severity: warn
    given: "$.openapi"
    then:
      function: pattern
      functionOptions:
        match: '^3\.0\.'

  servers-defined:
    description: Servers 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://"

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

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

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

  operation-tags-required:
    description: Every operation must have tags
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch]"
    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 define at least one 2xx response
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: responses
      function: truthy

  response-description-required:
    description: Every response must have a description
    severity: error
    given: "$.paths[*][*].responses[*]"
    then:
      field: description
      function: truthy

  schema-type-required:
    description: Schema components should have a type
    severity: warn
    given: "$.components.schemas[*]"
    then:
      field: type
      function: truthy

  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: warn
    given: "$..description"
    then:
      function: pattern
      functionOptions:
        match: ".+"

  operation-microcks-operation:
    description: Operations should include x-microcks-operation
    severity: info
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: x-microcks-operation
      function: truthy