Apache Atlas · API Governance Rules

Apache Atlas API Rules

Spectral linting rules defining API design standards and conventions for Apache Atlas.

12 Rules error 7 warn 5
View Rules File View on GitHub

Rule Categories

get info operation parameter response security servers

Rules

warn
info-title-prefix
API title must start with "Apache Atlas"
$.info.title
error
info-description-required
$.info
error
servers-defined
$
error
operation-summary-required
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-starts-with-apache-atlas
$.paths[*][get,post,put,patch,delete].summary
error
operation-operationId-required
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
$.paths[*][get,post,put,patch,delete].responses[*]
warn
security-schemes-defined
$.components
error
get-no-request-body
$.paths[*].get

Spectral Ruleset

Raw ↑ 
extends: spectral:oas
rules:
  info-title-prefix:
    description: API title must start with "Apache Atlas"
    severity: warn
    given: "$.info.title"
    then:
      function: pattern
      functionOptions:
        match: "^Apache Atlas"
  info-description-required:
    severity: error
    given: "$.info"
    then:
      field: description
      function: truthy
  servers-defined:
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy
  operation-summary-required:
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: summary
      function: truthy
  operation-summary-starts-with-apache-atlas:
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Apache Atlas"
  operation-operationId-required:
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: operationId
      function: truthy
  operation-tags-required:
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: tags
      function: truthy
  parameter-description-required:
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].parameters[*]"
    then:
      field: description
      function: truthy
  response-success-required:
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ['200']
            - required: ['201']
            - required: ['204']
  response-description-required:
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses[*]"
    then:
      field: description
      function: truthy
  security-schemes-defined:
    severity: warn
    given: "$.components"
    then:
      field: securitySchemes
      function: truthy
  get-no-request-body:
    severity: error
    given: "$.paths[*].get"
    then:
      field: requestBody
      function: falsy