Beatoven.ai · API Governance Rules

Beatoven.ai API Rules

Spectral linting rules defining API design standards and conventions for Beatoven.ai.

5 Rules error 3 warn 2

View Rules File View on GitHub

Rule Categories

beatoven

Rules

error

beatoven-info-contact

All Beatoven specs must include contact info.

$.info

error

beatoven-info-license

All Beatoven specs must declare a license.

$.info

warn

beatoven-operation-summary-title-case

Operation summaries must use Title Case.

$.paths.*[get,post,put,patch,delete].summary

error

beatoven-bearer-security

Beatoven endpoints require HTTP Bearer security.

$.components.securitySchemes

warn

beatoven-path-prefix

All Beatoven paths must be under /api/v1.

$.paths

Spectral Ruleset

extends:
  - spectral:oas
formats:
  - oas3
rules:
  beatoven-info-contact:
    description: All Beatoven specs must include contact info.
    given: $.info
    severity: error
    then:
      field: contact
      function: truthy
  beatoven-info-license:
    description: All Beatoven specs must declare a license.
    given: $.info
    severity: error
    then:
      field: license
      function: truthy
  beatoven-operation-summary-title-case:
    description: Operation summaries must use Title Case.
    given: $.paths.*[get,post,put,patch,delete].summary
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: '^([A-Z][A-Za-z0-9]*)(\s[A-Z][A-Za-z0-9]*)*$'
  beatoven-bearer-security:
    description: Beatoven endpoints require HTTP Bearer security.
    given: $.components.securitySchemes
    severity: error
    then:
      field: BearerAuth
      function: truthy
  beatoven-path-prefix:
    description: All Beatoven paths must be under /api/v1.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: '^/api/v1/'