Documentation & DX

x-ui-operation-id

`x-ui-operation-id` appears on operations. Its value is a string. Used by a single provider across 21 OpenAPI documents. Observed values include `/rest/organizations/paramId/commerce/v2/tracking-ids/paramId/context-mappings/pa`, `/rest/organizations/paramId/machinelearning/configuration/dne/documentextraction`, `/rest/organizations/paramId/sources/paramId/mappings/types/paramId/rules/paramId`, `/rest/organizations/paramId/sources/paramId/configuration/salesforce/objects/par`. Consistent with documentation & dx — this is inferred from where the key appears and what it carries, not from any published definition.

Documentation & DX derived description

How this description was produced. It is assembled from what was measured in the corpus — where this key appears in a document, what shape its value takes, the values observed, and how many providers use it. It is not taken from a published definition, because for most extensions none exists. Read it as evidence, not as a specification. If you own this extension and want it described properly, tell us.

502 occurrences

21 documents

1 providers

purpose-named

Where it appears

Location in the document	Occurrences
operation	502

What its value looks like

Value shape	Occurrences
string	502

Observed values

Sampled from the specifications, most frequent first.

/rest/organizations/paramId/commerce/v2/tracking-ids/paramId/context-mappings/pa/rest/organizations/paramId/machinelearning/configuration/dne/documentextraction/rest/organizations/paramId/sources/paramId/mappings/types/paramId/rules/paramId/rest/organizations/paramId/sources/paramId/configuration/salesforce/objects/par/api/preview/organizations/paramId/catalog-management/catalogs/paramId/view-defi/rest/organizations/paramId/commerce/v2/recommendations/slots/global/query-confi/rest/organizations/paramId/machinelearning/configuration/caseclassif/fields/par/rest/organizations/paramId_get

Providers publishing it

All 1.

coveo

Why this is not in OpenAPI

Extensions exist because a provider needed something the specification would not carry. Most of what they hold is not the API contract at all — it is operational metadata about the contract: documentation, lifecycle, policy, provenance, and now agents. That metadata is usually better placed alongside the contract, in an Overlay or an APIs.json index, than crammed inside it. See everything else doing the documentation & dx job.