Documentation & DX

x-note

`x-note` appears on operations. Its value is a structured object. Used by 6 providers across 11 OpenAPI documents. 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.
25 occurrences
11 documents
6 providers
purpose-named

Where it appears

Location in the documentOccurrences
root 3
info 2
operation 20

What its value looks like

Value shapeOccurrences
string4
object21

Observed values

Sampled from the specifications, most frequent first.

Verbatim provider-published document, re-serialized from JSON to YAML only; the 430 documentation records were harvested; two describe the same POST /api/v1/dmsFeatherless does not publish a machine-readable OpenAPI document (api.featherles

Providers publishing it

All 6.

3vjia-technologycopthisfeatherlessprivatedao-orgvonagezoho-cliq

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.