schema
schema
[!NOTE] Requires the
airbyte-agentCLI onPATH. Install viabrew install airbytehq/tap/airbyte-agentor see the project README.
Return the full machine-readable schema for an operation: the CLI-level parameter shape and the underlying OpenAPI route's parameters, request body, and response. Equivalent to <resource> <operation> --describe, but discoverable as a top-level command.
[!IMPORTANT] Run
airbyte-agent schema <resource> <operation>before writing code or scripts that consume an operation's output. Theapi.responseschema tells you exactly what fields will come back so you can pass--fieldscorrectly the first time.
Usage
airbyte-agent schema <resource> <operation>
# Examples
airbyte-agent schema workspaces list
airbyte-agent schema connectors execute
airbyte-agent schema organizations list
More from airbytehq/airbyte-agent-cli
workspaces-list
List and filter workspaces. Workspace names are the primary identifier for connector commands.
4workspaces-use
Set the default workspace stored in ~/.airbyte-agent/settings.json. Subsequent commands use this workspace when one isn't explicitly passed.
4connectors-list
List connectors configured in a workspace.
4connectors-delete
Permanently delete a connector from a workspace.
4organizations-list
List organizations the authenticated user belongs to.
4connectors-create
Install a new connector via the secure browser-based credential flow.
4