Class ResponseShape

Hierarchy

ResponseUtil
- ResponseShape

Index

Constructors

Methods

toOpenAPIRefPreferred

Constructors

constructor

new ResponseShape(name?: string): ResponseShape
Parameters
- Optionalname: string
Returns ResponseShape
Inherited from ResponseUtil.constructor
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/baseResponseUtils.d.ts:55

Methods

toOpenAPIRefPreferred

toOpenAPIRefPreferred(): Record<string, ReferenceObject | ResponseObject>
Returns Record<string, ReferenceObject | ResponseObject>
- Defined in src/responses/classes/ResponseShape.ts:5
toOpenAPIRefPreferred(
ctxt: IOpenAPIResponseContext,
): Record<string, ReferenceObject | ResponseObject>
Parameters
- ctxt: IOpenAPIResponseContext
Returns Record<string, ReferenceObject | ResponseObject>
- Defined in src/responses/classes/ResponseShape.ts:6