Mocking & testing

x-params-example

`x-params-example` appears on schema objects and properties. Its value is a string. Used by a single provider across 1 OpenAPI document. Observed values include `?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd`, `?key=favoritemovie`, `?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR&key=favoritemovie`, `?key=bestseller`. Consistent with mocking & testing — this is inferred from where the key appears and what it carries, not from any published definition.

Mocking & testing 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.
60 occurrences
1 documents
1 providers
purpose-named

Where it appears

Location in the documentOccurrences
schema 60

What its value looks like

Value shapeOccurrences
string54
object6

Observed values

Sampled from the specifications, most frequent first.

?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd?key=favoritemovie?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR&key=favoritemovie?key=bestseller?location_id=L0TBCBTB7P8RQ&key=bestseller?reward_id=9f18ac21-233a-31c3-be77-b45840f5a810?key=alternative_seller_name?merchant_id=DM7VKY8Q63GNP&key=alternative_seller_name

Providers publishing it

All 1.

square

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 mocking & testing job.