Catalog

Preview Catalog Operations

Changed on

Preview the operations of a catalog entry's spec (capped, offset-paginated).

tag and q filter the spec's operations server-side before windowing, so the UI's search box covers every operation in the spec and pages the filtered set via offset/limit ("Load more").

get/catalog/{api_id}/operations

Request

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

Path parameters

api_idstring required

Catalog identity of the API (domain[/sub-api]); send any / unencoded.

Example:stripe.com

Query parameters

offsetinteger

Number of matching operations to skip.

limitinteger

Maximum number of operations to return (0-200).

Example:25
tagstring nullable

Only return operations with a tag containing this text (case-insensitive).

Example:Charges
qstring nullable

Only return operations whose method, path, summary or operation ID contains this text (case-insensitive).

Example:charges

Response

Successful Response

offsetinteger required

Offset of the returned window.

security_schemesobject required

Slimmed components.securitySchemes projection.

totalinteger required

Total operations in the spec (pre-page).

truncatedboolean required

Whether more operations follow this window.

Example response

{
  "data": [],
  "info": {
    "description": "Payments.",
    "title": "Stripe",
    "version": "2024-01-01"
  },
  "offset": 0,
  "security_schemes": {},
  "total": 42,
  "truncated": true
}

Changes

  • c516481e6ed8Revision changes
    • info

      the endpoint scheme security OAuth2 was added to the API

  • d65fcba0d25aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's property type changed from array to string for status

    • info

      api operation id preview_catalog_operations_catalog__api_id__operations_get removed and replaced with previewCatalogOperations

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security AgentOauthAccessToken was removed from the API

    • info

      the endpoint scheme security HumanLogin was removed from the API

    • info

      the endpoint scheme security JenticApiKey was removed from the API

    • info

      api tag Catalog added

    • info

      api tag catalog removed

    • info

      added the new optional query request parameter q

    • info

      for the query request parameter limit, the min was decreased from 1.00 to 0.00

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status