OpenApiParameter.Example Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
public Microsoft.OpenApi.Any.IOpenApiAny Example { get; set; }member this.Example : Microsoft.OpenApi.Any.IOpenApiAny with get, setPublic Property Example As IOpenApiAny