Documentation & DX

x-stoplight

`x-stoplight` appears on schema objects and properties. Its value is a structured object. Used by 56 providers across 215 OpenAPI documents. It sits in the `x-stoplight-` namespace, so its meaning is defined by stoplight tooling rather than by OpenAPI. Consistent with documentation & dx — this is inferred from where the key appears and what it carries, not from any published definition.

Documentation & DX x-stoplight- namespace 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.

12052 occurrences

215 documents

56 providers

vendor-named

Where it appears

Location in the document	Occurrences
operation	1368
schema	10465
root	120
header	2
tag	24
response	33
requestBody	10
path	3
components	8
info	2
parameter	13
securityScheme	4

What its value looks like

Value shape	Occurrences
object	12030
string	21
empty	1

Observed values

Sampled from the specifications, most frequent first.

null*id006*id005&id006*id008&id008&id005

Providers publishing it

Showing 50 of 56.

accredify0604 actionpower activefence aftership apollo-insurance assignar autodesk-bim360 autodesk-fusion billdesk bond cart-com cloudchipr creatoriq deluxe diagnostic-robotics doorloop egym eliq ev-energy factset fareharbor finix finix-payments fixflo gumlet harness ironcore-labs kontaktio lianlian-global lili mailmodo mediamath narmi netcorecloud octo opaque open-food-facts open-mobility-foundation publiq punchh qfex qovery rea-group saviynt sendcloud sendlane shoppable spliceforms street-co striim

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.