Amazon Glue DataBrew · API Governance Rules

Amazon Glue DataBrew API Rules

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

7 Rules error 5 warn 1 info 1
View Rules File View on GitHub

Rule Categories

info microcks no operation response

Rules

warn
info-title-format
API title must reference Amazon Glue DataBrew
$.info.title
error
info-description-required
$.info
error
operation-summary-required
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
$.paths[*][get,post,put,patch,delete]
error
response-success-required
$.paths[*][get,post,put,patch,delete].responses
error
no-empty-descriptions
$..description
info
microcks-operation-extension
$.paths[*][get,post,put,patch,delete]

Spectral Ruleset

Raw ↑ 
rules:
  info-title-format:
    description: API title must reference Amazon Glue DataBrew
    severity: warn
    given: "$.info.title"
    then:
      function: pattern
      functionOptions:
        match: "^Amazon Glue DataBrew|^AWS Glue DataBrew"

  info-description-required:
    severity: error
    given: "$.info"
    then:
      field: description
      function: truthy

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

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

  response-success-required:
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ["200"]
            - required: ["201"]
            - required: ["204"]

  no-empty-descriptions:
    severity: error
    given: "$..description"
    then:
      function: pattern
      functionOptions:
        match: ".+"

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