Skip to content

Latest commit

 

History

History
55 lines (31 loc) · 1.39 KB

openapi.OpenApiExample.md

File metadata and controls

55 lines (31 loc) · 1.39 KB

api-typescript-generator / Modules / openapi / OpenApiExample

Interface: OpenApiExample

openapi.OpenApiExample

An example for a particular OpenAPI entity (i.e. parameter, schema, etc.).

See

https://swagger.io/specification/#example-object

Table of contents

Properties

Properties

description

• Optional description: string

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

externalValue

• Optional externalValue: string

A URL that points to 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.

summary

• Optional summary: string

Short description for the example.

value

• value: unknown

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