# ClickZetta 开放平台管理 API 的 OpenAPI Overlay
# 由云器自行发布。在不修改 https://yunqi.tech/openapi.json 原文件的前提下，补充联系方式、文档链接，并移除无法解析的服务器地址。
overlay: 1.0.0
x-method: published
x-publisher: Singdata
info:
  title: ClickZetta Open Platform API 补充信息
  version: 1.0.0
extends: https://yunqi.tech/openapi.json
actions:
  # ---------- info ----------
  - target: $.info
    description: 补充对外联系方式和用户协议。
    update:
      contact:
        name: Singdata
        email: service@yunqi.tech
        url: https://www.yunqi.tech/documents
      termsOfService: https://www.yunqi.tech/documents/user-agreement

  - target: $
    description: 补充文档入口。
    update:
      externalDocs:
        description: 云器 Lakehouse 文档中心
        url: https://www.yunqi.tech/documents

  # ---------- servers ----------
  - target: $.servers[?(@.url == 'https://api.singdata.com')]
    description: 2026-11-10 通过 8.8.8.8、1.1.1.1 和 223.5.5.5 查询，api.singdata.com 的默认 A 记录查询均未返回地址，因此不再作为接入地址推荐。新加坡节点管理接口的地址确认后再补充。
    remove: true

  # ---------- 每个模块的文档页 ----------
  - target: $.tags[?(@.name == 'Workspace')]
    update:
      externalDocs:
        description: 工作空间
        url: https://www.yunqi.tech/documents/workspace-introduction
  - target: $.tags[?(@.name == 'VirtualCluster')]
    update:
      externalDocs:
        description: 计算集群
        url: https://www.yunqi.tech/documents/tutorial_virtual_cluster
  - target: $.tags[?(@.name == 'Instance')]
    update:
      externalDocs:
        description: 服务实例
        url: https://www.yunqi.tech/documents/lakehouse_instance_overview
  - target: $.tags[?(@.name == 'User Management')]
    update:
      externalDocs:
        description: 用户管理
        url: https://www.yunqi.tech/documents/account_user_management
  - target: $.tags[?(@.name == 'DataSource')]
    update:
      externalDocs:
        description: 数据源配置
        url: https://www.yunqi.tech/documents/config-datasource
  - target: $.tags[?(@.name == 'ScheduleTask')]
    update:
      externalDocs:
        description: 任务开发与调度
        url: https://www.yunqi.tech/documents/task_development
  - target: $.tags[?(@.name == 'RealtimeTask')]
    update:
      externalDocs:
        description: 实时同步任务
        url: https://www.yunqi.tech/documents/realtime_sync
  - target: $.tags[?(@.name == 'MultiRealtimeDiTask')]
    update:
      externalDocs:
        description: 多表实时同步
        url: https://www.yunqi.tech/documents/multitable_realtime_sync
  - target: $.tags[?(@.name == 'Dqc')]
    update:
      externalDocs:
        description: 数据质量
        url: https://www.yunqi.tech/documents/lakehouse-dqc-guide