PingCAP · OpenAPI Overlay 1.0.0

API Evangelist enhancements for TiDB Cloud API (v1beta)

3 actions 3 updates update extends openapi/pingcap-tidb-cloud-v1beta-openapi-original.json

Generated by API Evangelist Written by API Evangelist tooling for PingCAP's API. It is a proposal applied on top of the contract, not a document PingCAP publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-slugx-apievangelist-sourcex-apievangelist-harvestedx-apievangelist-operationsx-apievangelist-base-urlx-apievangelist-authenticationx-apievangelist-authentication-artifact

Targets 1

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for TiDB Cloud API (v1beta)
  version: 1.0.0
extends: openapi/pingcap-tidb-cloud-v1beta-openapi-original.json
x-generated: '2026-08-02'
x-method: generated
x-source: apis.yml + repo artifacts (no mutation of the harvested original)
actions:
- target: $.info
  update:
    x-apievangelist-provider: PingCAP
    x-apievangelist-slug: pingcap
    x-apievangelist-source: https://docs.pingcap.com/tidbcloud/api/v1beta/
    x-apievangelist-harvested: '2026-08-02'
    x-apievangelist-operations: 30
- target: $.info
  update:
    x-apievangelist-base-url: https://api.tidbcloud.com/api/v1beta
- target: $.info
  update:
    x-apievangelist-authentication: HTTP Digest (RFC 7616) with a TiDB Cloud organization API key pair; not declared
      in the source spec (no securityDefinitions block)
    x-apievangelist-authentication-artifact: authentication/pingcap-authentication.yml
    x-apievangelist-rate-limit: 100 requests per minute per API key; X-Ratelimit-Limit-Minute / X-Ratelimit-Remaining-Minute
      / X-Ratelimit-Reset; 429 on exceed
    x-apievangelist-rate-limit-artifact: rate-limits/pingcap-rate-limits.yml
    x-apievangelist-error-envelope: google.rpc.Status {code, message, details[]} — not RFC 9457
    x-apievangelist-error-artifact: errors/pingcap-problem-types.yml
    x-apievangelist-conventions: conventions/pingcap-conventions.yml
    x-apievangelist-idempotency: none documented — retries of create operations are not deduplicated