OpenAPIHooks
@quik/openapi / OpenAPIHooks
Variable: OpenAPIHooks
constOpenAPIHooks:object
Defined in: index.ts:15
Collection of parser hooks used when generating the OpenAPI document.
Type Declaration
addComponentsParser
addComponentsParser: (
hook) =>void=addComponentsParserHook
Register a new components parser hook.
Parameters
hook
ComponentsParserHook
Callback used to extend the components section.
Returns
void
addPathsParser
addPathsParser: (
hook) =>void=addPathsParserHook
Register a new paths parser hook.
Parameters
hook
PathsParserHook
Callback used to extend the paths section.
Returns
void
addSecurityParser
addSecurityParser: (
hook) =>void=addSecurityParserHook
Register a new security parser hook.
Parameters
hook
SecurityParserHook
Callback used to extend the security schemes.
Returns
void
addSecurityRequirement
addSecurityRequirement: (
hook) =>void=addSecurityRequirementHook
Register a new security requirement parser hook.
Parameters
hook
SecurityRequirementParserHook
Callback used to extend the global security requirements.
Returns
void
addTagsParser
addTagsParser: (
hook) =>void=addTagsParserHook
Register a new tags parser hook.
Parameters
hook
TagsParserHook
Callback used to extend the tags collection.
Returns
void
addWebhooksParser
addWebhooksParser: (
hook) =>void=addWebhooksParserHook
Register a new webhooks parser hook.
Parameters
hook
WebhooksParserHook
Callback used to extend the webhooks section.
Returns
void