Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for OAS 3 callback documentation #223

Open
richiksc opened this issue Jun 15, 2022 · 0 comments
Open

Add support for OAS 3 callback documentation #223

richiksc opened this issue Jun 15, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@richiksc
Copy link

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)
 */
@kevinccbsg kevinccbsg added enhancement New feature or request good first issue Good for newcomers labels Jul 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants