Class MediaTypeShape

Hierarchy

MediaTypeUtil
- MediaTypeShape

Index

Constructors

Methods

setExamples setSchema

Constructors

constructor

new MediaTypeShape(mediaType?: MediaTypeShapeConfig): MediaTypeShape
Parameters
- OptionalmediaType: MediaTypeShapeConfig
Returns MediaTypeShape
Overrides MediaTypeUtil.constructor
- Defined in src/docs/classes/MediaTypeShape.ts:12

Methods

setExamples

setExamples(
examples: Record<string, ExampleShape | ExampleObject | ReferenceObject>,
noRef?: boolean,
): this
Parameters
- examples: Record<string, ExampleShape | ExampleObject | ReferenceObject>
- OptionalnoRef: boolean
Returns this
Overrides MediaTypeUtil.setExamples
- Defined in src/docs/classes/MediaTypeShape.ts:27

setSchema

setSchema(
schema: ReferenceObject | SchemaObject | SchemaShape,
noRef?: boolean,
): this
Parameters
- schema: ReferenceObject | SchemaObject | SchemaShape
- OptionalnoRef: boolean
Returns this
Overrides MediaTypeUtil.setSchema
- Defined in src/docs/classes/MediaTypeShape.ts:45