SuperAPI AI 工具集

schema

编程与开发

查看项目

更新于 10-15 19:53

技能介绍

用途:schema 是 airbyte-agent CLI 的顶层命令,用于输出某个操作的完整机器可读 schema,包括 CLI 层参数结构与底层 OpenAPI 路由的参数、请求体和响应。它等价于 <resource> <operation> --describe,但以顶层命令形式提供,便于发现。

主要能力:输出分为两部分。params 表示 CLI 调用方在 --json 载荷中传入的内容,含 CLI 便利项(如 workspace 回退、name/id 交替等);api 表示实际发往 Airbyte API 的线上信息,含 path、method、summary、description、parameters、request_body(POST/PATCH/PUT 路由)以及 200/2xx 响应 schema($ref 已内联)。未映射到 OpenAPI 路由的操作会省略 api 块。

使用方式:需先在 PATH 中安装 airbyte-agent CLI,可通过 brew install airbytehq/tap/airbyte-agent 或参考项目 README。命令格式为 airbyte-agent schema <resource> <operation>,例如 airbyte-agent schema workspaces list、airbyte-agent schema connectors execute、airbyte-agent schema organizations list。

适用场景:在编写依赖某操作响应结构的自动化前,先读取 api.response 以精确设计过滤与解析;当 --fields 返回结果不符合预期时,用 api.response 确认确切字段名与结构;作为智能体探索 API 表面时,无需发起请求即可了解操作行为。

限制:schema 与 --describe 均不会发起 API 调用,无需认证即可安全运行。未知资源或操作会以 JSON 形式输出到 stderr,退出码为 3。configure 虽为纯本地命令,但不是已注册操作,而是顶层命令。