Barndoor · API Governance Rules

Barndoor API Rules

Spectral linting rules defining API design standards and conventions for Barndoor.

14 Rules error 9 warn 5
View Rules File View on GitHub

Rule Categories

api apis bearer info no operation organization response servers

Rules

error
info-title-required
Info title must be present.
$.info
error
info-description-required
Info description must be present.
$.info
warn
info-contact-required
Info contact must be present.
$.info
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-title-case
Operation summaries should be in Title Case.
$.paths[*][get,post,put,patch,delete].summary
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Every response must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
error
no-empty-descriptions
Descriptions must not be empty.
$..description
warn
bearer-auth-jwt
BearerAuth security scheme should declare bearerFormat as JWT for Barndoor.
$.components.securitySchemes.BearerAuth
error
servers-required
At least one server must be declared.
$
warn
organization-id-variable
Server URLs should use the {organization_id} template variable.
$.servers[*]
error
apis-json-description
Barndoor APIs.json must have a description.
$
error
api-has-documentation
All Barndoor API entries must have a Documentation property.
$.apis[*]

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas

rules:
  info-title-required:
    description: Info title must be present.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy

  info-description-required:
    description: Info description must be present.
    severity: error
    given: $.info
    then:
      field: description
      function: truthy

  info-contact-required:
    description: Info contact must be present.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy

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

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

  operation-summary-title-case:
    description: Operation summaries should be in Title Case.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].summary
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z]"

  operation-tags-required:
    description: Every operation must have at least one tag.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy

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

  no-empty-descriptions:
    description: Descriptions must not be empty.
    severity: error
    given: $..description
    then:
      function: truthy

  bearer-auth-jwt:
    description: BearerAuth security scheme should declare bearerFormat as JWT for Barndoor.
    severity: warn
    given: $.components.securitySchemes.BearerAuth
    then:
      field: bearerFormat
      function: pattern
      functionOptions:
        match: "JWT"

  servers-required:
    description: At least one server must be declared.
    severity: error
    given: $
    then:
      field: servers
      function: truthy

  organization-id-variable:
    description: Server URLs should use the {organization_id} template variable.
    severity: warn
    given: $.servers[*]
    then:
      field: url
      function: pattern
      functionOptions:
        match: "{organization_id}"

  apis-json-description:
    description: Barndoor APIs.json must have a description.
    severity: error
    given: $
    then:
      field: description
      function: truthy

  api-has-documentation:
    description: All Barndoor API entries must have a Documentation property.
    severity: error
    given: $.apis[*]
    then:
      field: properties
      function: schema
      functionOptions:
        schema:
          type: array
          contains:
            type: object
            properties:
              type:
                const: Documentation
            required:
              - type