Arch Coal · API Governance Rules

Arch Coal API Rules

Spectral linting rules defining API design standards and conventions for Arch Coal.

13 Rules error 10 warn 3
View Rules File View on GitHub

Rule Categories

get info openapi operation parameter response security servers

Rules

error
info-title-arch-coal-prefix
API title must start with "Arch Coal"
$.info
warn
info-description-required
API must have a description
$.info
error
openapi-version-3
Use OpenAPI 3.0.x
$
error
servers-defined
Server URLs must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*]
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-prefix
Operation summaries should start with "Arch Coal"
$.paths[*][get,post,put,delete,patch]
error
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
Parameters must have descriptions
$.paths[*][*].parameters[*]
error
response-success-required
Operations must define success responses
$.paths[*][get,post,put,delete,patch].responses
error
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have request bodies
$.paths[*].get

Spectral Ruleset

Raw ↑ 
rules:
  info-title-arch-coal-prefix:
    description: API title must start with "Arch Coal"
    severity: error
    given: "$.info"
    then:
      field: title
      function: pattern
      functionOptions:
        match: "^Arch Coal"
  info-description-required:
    description: API must have a description
    severity: warn
    given: "$.info"
    then:
      field: description
      function: truthy
  openapi-version-3:
    description: Use OpenAPI 3.0.x
    severity: error
    given: "$"
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\.0\\."
  servers-defined:
    description: Server URLs must be defined
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy
  servers-https:
    description: Server URLs must use HTTPS
    severity: error
    given: "$.servers[*]"
    then:
      field: url
      function: pattern
      functionOptions:
        match: "^https://"
  operation-id-required:
    description: All operations must have an operationId
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: operationId
      function: truthy
  operation-summary-required:
    description: All operations must have a summary
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Operation summaries should start with "Arch Coal"
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: summary
      function: pattern
      functionOptions:
        match: "^Arch Coal"
  operation-tags-required:
    description: All operations must have tags
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: tags
      function: truthy
  parameter-description-required:
    description: Parameters must have descriptions
    severity: warn
    given: "$.paths[*][*].parameters[*]"
    then:
      field: description
      function: truthy
  response-success-required:
    description: Operations must define success responses
    severity: error
    given: "$.paths[*][get,post,put,delete,patch].responses"
    then:
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined
    severity: error
    given: "$.components"
    then:
      field: securitySchemes
      function: truthy
  get-no-request-body:
    description: GET operations must not have request bodies
    severity: error
    given: "$.paths[*].get"
    then:
      field: requestBody
      function: falsy