Tibber · API Governance Rules

Tibber API Rules

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

6 Rules error 4 warn 2
View Rules File View on GitHub

Rule Categories

tibber

Rules

error
tibber-operation-id-required
Every operation must declare an operationId in lowerCamelCase.
$.paths[*][get,post,put,delete,patch]
warn
tibber-operation-summary-title-case
Operation summaries should use Title Case sentence style.
$.paths[*][get,post,put,delete,patch].summary
error
tibber-tag-required
Every operation must be tagged so the docs site can group it.
$.paths[*][get,post,put,delete,patch]
error
tibber-bearer-or-oauth
Every spec must declare bearer or OAuth 2.0 as a security scheme.
$.components.securitySchemes
error
tibber-server-https
Server URLs must be HTTPS.
$.servers[*].url
warn
tibber-iso-currency-on-price
Price-shaped schemas must include a `currency` field.
$.components.schemas[?(@property == 'Price' || @property == 'TibberPrice')]

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
rules:
  tibber-operation-id-required:
    description: Every operation must declare an operationId in lowerCamelCase.
    given: $.paths[*][get,post,put,delete,patch]
    severity: error
    then:
      field: operationId
      function: truthy
  tibber-operation-summary-title-case:
    description: Operation summaries should use Title Case sentence style.
    given: $.paths[*][get,post,put,delete,patch].summary
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^[A-Z]"
  tibber-tag-required:
    description: Every operation must be tagged so the docs site can group it.
    given: $.paths[*][get,post,put,delete,patch]
    severity: error
    then:
      field: tags
      function: truthy
  tibber-bearer-or-oauth:
    description: Every spec must declare bearer or OAuth 2.0 as a security scheme.
    given: $.components.securitySchemes
    severity: error
    then:
      function: truthy
  tibber-server-https:
    description: Server URLs must be HTTPS.
    given: $.servers[*].url
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "^https://"
  tibber-iso-currency-on-price:
    description: Price-shaped schemas must include a `currency` field.
    given: "$.components.schemas[?(@property == 'Price' || @property == 'TibberPrice')]"
    severity: warn
    then:
      field: properties.currency
      function: truthy