covenix / ExampleMetadata

Interface: ExampleMetadata

Defined in: src/metadata.ts:102

An example value attached to a route by @Example.

Properties

status?

optional status?: number

Defined in: src/metadata.ts:104

Response status the example illustrates; omitted means the request body.

---

value

value: unknown

Defined in: src/metadata.ts:106

The example value, surfaced on the OpenAPI media type.