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

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this

find_rulesBrowse and filter every ruleset in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This ruleset

curl "https://apis.io/api/v1/rules/tikv-rules"

All spectral rules

curl "https://apis.io/api/v1/rules?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.