Interface OpenApiUnion

A special type of schema, used for multiple "types" as specified in the latest JSON Schema.

interface OpenApiUnion {
    addDescription(description: string): this;
    addExample(example: any): this;
    addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
    addExternalDocs(docs: OpenApiDocumentation): this;
    ofTypes(...val: (OpenApiReferenceObject | OpenApiSchema)[]): this;
    override(overrideVal: unknown): this;
    toJSON(): unknown;
}

Hierarchy

Omit<SchemaInterface<OpenApiSchema | OpenApiReferenceObject>, omitValues>
- OpenApiUnion

Index

Methods

addDescription addExample addExtensions addExternalDocs ofTypes override toJSON

Methods

addDescription

addDescription(description: string): this
Adds a description to this OpenApiSchema
Parameters
- description: string
  Description
Returns this
Inherited from Omit.addDescription
- Defined in core/openapiv3/lib/base.ts:61

addExample

addExample(example: any): this
Parameters
- example: any
Returns this
Inherited from Omit.addExample
- Defined in core/openapiv3/lib/base.ts:68

addExtensions

addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this
Extend the specification with an extension object schema.
Parameters
- mappings: { [key: `x-${string}`]: OpenApiSchema }
  key value mappings with names MUST beginning with "x-"
Returns this
Inherited from Omit.addExtensions
- Defined in core/openapiv3/lib/base.ts:50

addExternalDocs

addExternalDocs(docs: OpenApiDocumentation): this
Adds an external documentation to this OpenApiSchema
Parameters
- docs: OpenApiDocumentation
  Documentation to add to this schema.
Returns this
Inherited from Omit.addExternalDocs
- Defined in core/openapiv3/lib/base.ts:67

ofTypes

ofTypes(...val: (OpenApiReferenceObject | OpenApiSchema)[]): this
Compose multiple OpenApi schema types.
Parameters
- ...val: (OpenApiReferenceObject | OpenApiSchema)[]
  A list of schema types to union over, creating a union schema.
Returns this
- Defined in core/openapiv3/schema/OpenApiUnion.ts:29

override

override(overrideVal: unknown): this
Overrides the toJSON method for a custom serialization.

WARNING: overrideVal must be serializable and future changes are subject to breaking.
Parameters
- overrideVal: unknown
  Overrides the serialization of this object into this value.
Returns this
Inherited from Omit.override
- Defined in core/openapiv3/lib/base.ts:41

toJSON

toJSON(): unknown
Serializes the object into its equivalent OpenApi JSON value.

Returns unknown
Inherited from Omit.toJSON
- Defined in core/openapiv3/lib/base.ts:33