TiDB Cloud Data Service API — Deployments

naftiko: 1.0.0-alpha2
info:
  label: TiDB Cloud Data Service API — Deployments
  description: 'TiDB Cloud Data Service API — Deployments. 2 operations. Lead operation: List deployments. Self-contained
    Naftiko capability covering one Tidb business surface.'
  tags:
  - Tidb
  - Deployments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TIDB_API_KEY: TIDB_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-data-service-deployments
    baseUri: https://dataservice.tidbapi.com/v1beta1
    description: TiDB Cloud Data Service API — Deployments business capability. Self-contained, no shared references.
    resources:
    - name: dataApps-dataAppId-deployments
      path: /dataApps/{dataAppId}/deployments
      operations:
      - name: listdeployments
        method: GET
        description: List deployments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdeployment
        method: POST
        description: Create a deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: cloud-data-service-deployments-rest
    port: 8080
    description: REST adapter for TiDB Cloud Data Service API — Deployments. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/dataapps/{dataappid}/deployments
      name: dataapps-dataappid-deployments
      description: REST surface for dataApps-dataAppId-deployments.
      operations:
      - method: GET
        name: listdeployments
        description: List deployments
        call: cloud-data-service-deployments.listdeployments
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdeployment
        description: Create a deployment
        call: cloud-data-service-deployments.createdeployment
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-data-service-deployments-mcp
    port: 9090
    transport: http
    description: MCP adapter for TiDB Cloud Data Service API — Deployments. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-deployments
      description: List deployments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-data-service-deployments.listdeployments
      outputParameters:
      - type: object
        mapping: $.
    - name: create-deployment
      description: Create a deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cloud-data-service-deployments.createdeployment
      outputParameters:
      - type: object
        mapping: $.