Documentation & DX

x-readme

`x-readme` appears on operations. Its value is a structured object. Used by 104 providers across 522 OpenAPI documents. It sits in the `x-readme-` namespace, so its meaning is defined by readme 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-readme- 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.
1714 occurrences
522 documents
104 providers
vendor-named

Where it appears

Location in the documentOccurrences
root 439
operation 1273
info 2

What its value looks like

Value shapeOccurrences
object1708
empty6

Providers publishing it

Showing 50 of 104.

1nce8x8act-onalkemicsaltoiraamberdataappsflyerarcadiapower2asanaatratoayla-networksbazaarvoicebloomreachbokiobrandwatchcadanacardlyticscargoaicensyscentrifychargeafterclerk-iocloudguardcm-comconnexpayconstructoriocontrolupcoradealhubdemandbasedoppeldotdigitaldynamic-yieldelation-healthfamafeedlyfiat-republicfigmentfireblocksfrontegggreensparkhpehubflohumanityinscribeironcladiugujasperjeengkanmon

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.