api-morph / ExampleObject

Interface: ExampleObject

Defined in: src/types/openapi.ts:835

An object grouping an internal or external example value with basic summary and description metadata. This object is typically used in fields named examples (plural), and is a referenceable alternative to older example (singular) fields that do not support referencing or metadata.

See

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

Indexable

[key: `x-${string}`]: any

This object MAY be extended with Specification Extensions.

Properties

description?

optional description: string

Defined in: src/types/openapi.ts:844

Long description for the example. CommonMark syntax MAY be used for rich text representation.

---

externalValue?

optional externalValue: string

Defined in: src/types/openapi.ts:858

A URI that identifies the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive. See the rules for resolving Relative References.

---

summary?

optional summary: string

Defined in: src/types/openapi.ts:839

Short description for the example.

---

value?

optional value: any

Defined in: src/types/openapi.ts:851

Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.