Skip to content

Enable '@openapi' annotation for spec comments #193

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

Closed
wants to merge 1 commit into from
Closed

Enable '@openapi' annotation for spec comments #193

wants to merge 1 commit into from

Conversation

jessevdp
Copy link

Since the specification has been renamed to OpenAPI I thought it would be appropriate to allow for @openapi annotation in addition to using @swagger.

/**
 * @openapi
 * /example:
 *   get:
 *     summary: "Get all"
 *     responses:
 *       200:
 *         description: OK
 */

I only changed a single if statement, I have no clue if this change would impact other area's of the code as well. If additional changes are required, please point me in the right direction.

@kalinchernev
Copy link
Contributor

kalinchernev commented Mar 22, 2020

Hi @jessevdp I think your change will be quite enough to be honest without digging too deep.
Please update to latest master as I just cleaned up some linting (and perttier) rules and test setup, etc. Should be easier to contribute your changes.

Please add a test for the new feature. You can start off any of the simple examples here Please name it accordingly. Having a passing test for the new feature will suffice for a merge :)

@Uzlopak
Copy link
Contributor

Uzlopak commented May 7, 2020

I created a corresponding PR with the change and with a simple test. Would be cool to merge "my" PR soon, as I would like to have potential replacement for openapi-jsdoc.

@kalinchernev
Copy link
Contributor

kalinchernev commented Sep 25, 2020

Followed up on the one with the tests and it's merged.
Thank you @jessevdp and @Uzlopak!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants