express-jsdoc-swagger icon indicating copy to clipboard operation
express-jsdoc-swagger copied to clipboard

Add support for OAS 3 callback documentation

Open richiksc opened this issue 3 years ago • 0 comments

Is your feature request related to a problem? Please describe. Add support for documenting callbacks, which are in OpenAPI specification v3 - https://swagger.io/docs/specification/callbacks/. Some services I'm documenting rely heavily on callbacks and are a common pattern in webhooks and publish/subscribe pattern.

Describe the solution you'd like Add support for documenting callbacks through, for example, a @callback annotation on an endpoint.

/*
 * @callback {object} eventName - description - application/json
 * Response body (JSON)
 */

richiksc avatar Jun 15 '22 00:06 richiksc