Class MediaTypeShape

Hierarchy (View Summary)

MediaTypeUtil
- MediaTypeShape

Index

Constructors

Methods

setEncoding setExample setExamples setSchema toObject

Constructors

constructor

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

Methods

setEncoding

setEncoding(encoding: Record<string, EncodingObject>): MediaTypeCreator
Parameters
- encoding: Record<string, EncodingObject>
Returns MediaTypeCreator
Inherited from MediaTypeUtil.setEncoding
- Defined in node_modules/@novice1/api-doc-generator/lib/generators/openapi/services/mediaTypeService.d.ts:7

setExample

setExample(value: unknown): MediaTypeCreator
Parameters
- value: unknown
Returns MediaTypeCreator
Inherited from MediaTypeUtil.setExample
- Defined in node_modules/@novice1/api-doc-generator/lib/generators/openapi/services/mediaTypeService.d.ts:5

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

toObject

toObject(): MediaTypeObject
Returns MediaTypeObject
Inherited from MediaTypeUtil.toObject
- Defined in node_modules/@novice1/api-doc-generator/lib/generators/openapi/services/mediaTypeService.d.ts:9