api
api schema
Show operation schema
Show the contract schema for an API operation: HTTP method and path, every parameter (name, location, required, type), the request body shape, and the success response shape. 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, --no-trunc, --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 operation, tag, HTTP method, path, parameters (name, location, required, type), request body shape, and response shape. With --json, returns the full operation schema object.