package
[](https://github.com/climba03003/fastify-openapi/actions/workflows/ci.yml) [ {
/**
* @param {DocumentGenerator} instance document generator
* @param {RouteOptions|OperationObject} schema last hook result. If it is the first hook, it is the original schema.
* @param {RouteOptions} originalSchema original schema
* @param {object} additionalInformation additional information
* @returns {OperationObject} operation object
**/
instance.addHook('onPath', function(instance, schema, originalSchema, additionalInformation) {
return schema
})
}On Query, Param, Header and Cookie hook are executed for generate OpenAPI ParameterObject.
function plugin(instance) {
/**
* @param {DocumentGenerator} instance document generator
* @param {ParameterSchema|ParameterObject} schema last hook result. If it is the first hook, it is the original schema.
* @param {ParameterSchema} originalSchema original schema
* @param {object} additionalInformation additional information
* @returns {ParameterObject} operation object
**/
instance.addHook('onQuery', function(instance, schema, originalSchema, additionalInformation) {
return schema
})
instance.addHook('onParam', function(instance, schema, originalSchema, additionalInformation) {
return schema
On Body hook is executed for generate OpenAPI RequestBodyObject.
function plugin(instance) {
/**
* @param {DocumentGenerator} instance document generator
* @param {JSONSchema|RequestBodyObject} schema last hook result. If it is the first hook, it is the original schema.
* @param {JSONSchema} originalSchema original schema
* @param {object} additionalInformation additional information
* @returns {RequestBodyObject} operation object
**/
instance.addHook('onPath', function(instance, schema, originalSchema, additionalInformation) {
return schema
})
}On Response hook is executed for generate OpenAPI ResponsesObject.
function plugin(instance) {
/**
* @param {DocumentGenerator} instance document generator
* @param {JSONSchema|RequestBodyObject} schema last hook result. If it is the first hook, it is the original schema.
* @param {JSONSchema} originalSchema original schema
* @param {object} additionalInformation additional information
* @returns {ResponsesObject} operation object
**/
instance.addHook('onResponse', function(instance, schema, originalSchema, additionalInformation) {
return schema
})
}On Transform hook is executed for generate valid schema.
function plugin(instance) {
/**
* @param {DocumentGenerator} instance document generator
* @param {unknown} schema last hook result. If it is the first hook, it is the original schema.
* @param {unknown} originalSchema original schema
* @param {object} additionalInformation additional information
* @returns {JSONSchema} operation object
**/
instance.addHook('onTransform', function(instance, schema, originalSchema, additionalInformation) {
return schema
})
}