Interface IOneOf

interface IOneOf {
    deprecated?: boolean;
    description?: string;
    discriminator?: OpenApiV3_1.IJsonSchema.IOneOf.IDiscriminator;
    example?: any;
    examples?: any[] | Record<string, any>;
    oneOf: OpenApiV3_1.IJsonSchema[];
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}

Hierarchy (View Summary)

OpenApiV3_1.IJsonSchema.__IAttribute
- IOneOf
  - IMixed

Index

Properties

deprecated? description? discriminator? example? examples? oneOf readOnly? title? writeOnly?

Properties

`Optional`deprecated

deprecated?: boolean

Whether the type is deprecated or not.

`Optional`description

description?: string

Detailed description of the schema.

`Optional`discriminator

discriminator?: OpenApiV3_1.IJsonSchema.IOneOf.IDiscriminator

`Optional`example

example?: any

Example value.

`Optional`examples

examples?: any[] | Record<string, any>

oneOf

oneOf: OpenApiV3_1.IJsonSchema[]

`Optional`readOnly

readOnly?: boolean

Whether the property is read-only.

`Optional`title

title?: string

Title of the schema.

`Optional`writeOnly

writeOnly?: boolean

Whether the property is write-only.