Skip to content

[I] OpenAPI3Example

A reusable parameter or payload example, supplied inline or by an external URL.

https://spec.openapis.org/oas/v3.0.4.html#example-object

PropertyTypeDescription
description?stringExplanation of the example, which may use CommonMark.
externalValue?stringURL of example data that cannot be included inline; mutually exclusive with value.
summary?stringShort label that distinguishes this example from others.
value?unknownInline example data; mutually exclusive with externalValue.