api
api schema
Show operation schema
Show the schema details for an API operation, including the HTTP method, path,
tag, and operation ID. You can look up operations by their tag.method name
(e.g. projects.listProjects), by operationId, or by route string.
Usage
pgbeam api schema <operation>Options
| Option | Description | Required | Default |
|---|---|---|---|
<operation> | Operation name in tag.method format (e.g. projects.listProjects), operationId, or route string | Yes | - |
Global options
All global options (--token, --profile,
--project, --org, --json, --no-color, --debug) are also available on
this command.
Examples
# Look up by tag.method name
pgbeam api schema projects.listProjects
# Look up by operationId
pgbeam api schema listProjects
# Get schema as JSON
pgbeam api schema projects.listProjects --jsonOutput
Displays the tag, operation name, HTTP method, and API path. With --json,
returns the full operation metadata object.