Sign in
Catalog

Preview Catalog Operations

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

Path parameters

api_idstring required

Query parameters

offsetinteger
limitinteger
tagstring nullable
qstring nullable

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

Changed in 3 of the 85 revisions of this API.329

  • d65fcba0d25a228See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ▲

      the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • ○

      api operation id preview_catalog_operations_catalog__api_id__operations_get removed and replaced with previewCatalogOperations

      api-operation-id-removed

    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security AgentOauthAccessToken was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security HumanLogin was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security JenticApiKey was removed from the API

      api-security-removed

    • ○

      api tag Catalog added

      api-tag-added

    • ○

      api tag catalog removed

      api-tag-removed

    • ○

      added the new optional query request parameter q

      new-optional-request-parameter

    • ○

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

      request-parameter-min-decreased

    • ○

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

      response-media-type-name-specialized

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property code to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property instance to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property title to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property type to the response with the 422 status

      response-optional-property-added

    • ○

      the response property detail became required for the status 422

      response-property-became-required

    • ○

      added the required property data to the response with the 200 status

      response-required-property-added

    • ○

      added the required property info to the response with the 200 status

      response-required-property-added

    • ○

      added the required property offset to the response with the 200 status

      response-required-property-added

    • ○

      added the required property security_schemes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property total to the response with the 200 status

      response-required-property-added

    • ○

      added the required property truncated to the response with the 200 status

      response-required-property-added

    This revision also has 61 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2f5d077129371See the full diff
    • ○

      endpoint added

      endpoint-added

  • 76e8f60637281See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 179 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog