ParameterExampleContract interface

Parameter example.

Properties

description

Long description for the example

externalValue

A URL that points to the literal example

summary

Short description for the example

value

Example value. May be a primitive value, or an object.

Property Details

description

Long description for the example

description?: string

Property Value

string

externalValue

A URL that points to the literal example

externalValue?: string

Property Value

string

summary

Short description for the example

summary?: string

Property Value

string

value

Example value. May be a primitive value, or an object.

value?: any

Property Value

any