Inspect

Inspect operation

Changed on

Inspect an operation — resolve to full structural detail.

api.vendor/api.name/api.version in the result is the canonical API reference: the identity to use in credential scopes, revision pins and other API references. api.display_name (optional) is a human-readable label only.

get/inspect

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /inspect
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Query parameters

idstring nullable

METHOD URL identifier

Example:GET https://api.stripe.com/v1/charges
operation_idstring nullable

Operation ID

Example:listCharges
revision_idstring nullable

Pin to specific revision

Example:3f2b8c1e-7d4a-4e9b-a6c5-1d2e3f4a5b6c
detail'summary' | 'full'

Level of detail to return; only summary is currently supported.

Example:summary

Response

Successful Response

unknown required

Changes