[I] OpenAPIExample3_2
Allows sharing examples for operation responses.
https://spec.openapis.org/oas/v3.2.0.html#example-object
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from |
|---|---|---|---|
dataValue? | unknown | An example of the data structure that MUST be valid according to the relevant schema. See https://spec.openapis.org/oas/v3.2.0.html#example-object | - |
description? | string | Explanation of the example, which may use CommonMark. | OpenAPI3Example.description |
externalValue? | string | URL of example data that cannot be included inline; mutually exclusive with value. | OpenAPI3Example.externalValue |
serializedValue? | string | An example of the serialized form of the value, including encoding and escaping See https://spec.openapis.org/oas/v3.2.0.html#example-object | - |
summary? | string | Short label that distinguishes this example from others. | OpenAPI3Example.summary |
value? | unknown | Inline example data; mutually exclusive with externalValue. | OpenAPI3Example.value |