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

OpenAPI not Swagger since 2016 #93

Closed
wants to merge 2 commits into from
Closed

OpenAPI not Swagger since 2016 #93

wants to merge 2 commits into from

Conversation

philsturgeon
Copy link

@philsturgeon philsturgeon commented Sep 3, 2019

Fixes #58

This was discussed as a v1.0 feature but v1.0 has sailed, so im sending this PR to help get it done for v2.0.

Swagger is a) trademark of SmartBear, b) used almost exclusively by old crap unmaintained projects which do not support OpenAPI v3.0.

Your project is neither, but its gonna get confused for the latter because of the name. Please update to call it OpenAPI.

This was discussed as a v1.0 feature but v1.0 has sailed, so im sending this PR to help get it done for v2.0.

Swagger is a) trademark of SmartBear, b) used almost exclusively by old crap unmaintained projects which do not support OpenAPI v3.0.

Your project is neither, but its gonna get confused for the latter because of the name. Please update to call it OpenAPI.
Copy link
Collaborator

@kobik kobik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any objection to @kibertoad suggestion in the issue, to change the name to openapi-validation?

@philsturgeon
Copy link
Author

philsturgeon commented Sep 3, 2019

openapi-validator works but it is a liiiitle bit vague. Validation can be "data validation" or "schema validation" and it's not clear which you are talking about. The node- prefix I added kinda hints towards server-side so that leads folks to thinking about data validation, but maybe openapi-request-validator would be cool, or openapi-validation-middleware

It just needs to be something that hints at what it's doing.

@philsturgeon
Copy link
Author

Here is your PHP counterpart https://github.com/hkarlstrom/openapi-validation-middleware for inspiration.

@kibertoad
Copy link
Collaborator

@philsturgeon There is existing library with that name, unfortunately: https://www.npmjs.com/package/openapi-request-validator

We could use openapi-request-ajv-validator, to preserve a bit of original brand, I guess.

@philsturgeon
Copy link
Author

Whatever you like! :)

@philsturgeon
Copy link
Author

The main differentiation between this one and the linked project is that this is a middleware.

openapi-validation-middleware

or something. They also have express-openapi and koa-openapi, so maybe some convergence could happen. We have a lot of similar tools floating around and everyone is working hard on solving the same problems is only ever so slightly different ways.

@kobik
Copy link
Collaborator

kobik commented Apr 14, 2020

I guess we can finally close this one @philsturgeon

@philsturgeon philsturgeon deleted the openapi branch April 14, 2020 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Renaming to express-openapi-validation
3 participants