[I] OpExample
Example inputs and corresponding result attached to an operation, with optional display metadata.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
description? | readonly | string | Description of the example | ExampleOptions.description |
parameters? | readonly | Value | Value assignable to the operation’s parameter model, or absent for a result-only example. | - |
returnType? | readonly | Value | Value assignable to the operation’s return type, or absent for a parameter-only example. | - |
title? | readonly | string | The title of the example | ExampleOptions.title |