TiKV · API Governance Rules

TiKV API Rules

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

4 Rules error 2 warn 2

View Rules File View on GitHub

Rule Categories

tikv

Rules

error

tikv-operation-summary

All operations must have a summary

$.paths[*][*]

warn

tikv-operation-tags

All operations must have tags

$.paths[*][*]

error

tikv-operation-id

All operations must have an operationId

$.paths[*][*]

warn

tikv-response-description

All responses must have a description

$.paths[*][*].responses[*]

Spectral Ruleset

extends: spectral:oas
rules:
  tikv-operation-summary:
    description: All operations must have a summary
    message: "Operation must have a summary"
    severity: error
    given: "$.paths[*][*]"
    then:
      field: summary
      function: truthy

  tikv-operation-tags:
    description: All operations must have tags
    message: "Operation must have at least one tag"
    severity: warn
    given: "$.paths[*][*]"
    then:
      field: tags
      function: truthy

  tikv-operation-id:
    description: All operations must have an operationId
    message: "Operation must have an operationId"
    severity: error
    given: "$.paths[*][*]"
    then:
      field: operationId
      function: truthy

  tikv-response-description:
    description: All responses must have a description
    message: "Response must have a description"
    severity: warn
    given: "$.paths[*][*].responses[*]"
    then:
      field: description
      function: truthy