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

Renaming to express-openapi-validation #58

Closed
philsturgeon opened this issue Mar 19, 2019 · 8 comments
Closed

Renaming to express-openapi-validation #58

philsturgeon opened this issue Mar 19, 2019 · 8 comments
Milestone

Comments

@philsturgeon
Copy link

Hey, I think the name express-openapi-validation would be much more fitting from this project. Since the name change from OpenAPI to Swagger 3 and a bit years ago, the word Swagger is only referring to tools by SmartBear, and it causes a lot of confusion in the community to have folks keep calling everything Swagger when that is no longer the name.

Also, it's great that you're using AJV under the hood, but you probably want to protect that implementation detail from your end users allowing you to change the validator in the future.

I'm going to accept the PR for openapi.tools for now (apisyouwonthate/openapi.tools#87), but it would be awesome if you could update the name sometime. :)

@kibertoad
Copy link
Collaborator

Considering that it's not just Express anymore, probably something along the lines of 'openapi-validation' would be even better :D

@kobik kobik added this to the 1.0.0 milestone Jun 23, 2019
@philsturgeon
Copy link
Author

@kobik hey, congratulations on v1.0 but it looks like this issue was missed?

@kobik kobik modified the milestones: 1.0.0, 2.0.0 Sep 3, 2019
@kobik
Copy link
Collaborator

kobik commented Sep 3, 2019

Thanks a lot @philsturgeon for the PR!

We've decided to postpone it to the next major release.

In order to pull this out correctly, I believe that the way to rename the package should go like that

  1. Rename github project name in order to preserve all history
  2. Fork it to the old project name
  3. Change package name references in source code
  4. Publish under the new name
  5. Add deprecation message in the fork with reference to the new package name
  6. Publish the forked project to npm

WDYT @idanto @kibertoad @philsturgeon

@philsturgeon
Copy link
Author

philsturgeon commented Sep 3, 2019 via email

@kobik
Copy link
Collaborator

kobik commented Apr 13, 2020

@kibertoad, @idanto @philsturgeon, going to rename the package to openapi-validation-middleware if there are no objections according the process described above.

@kibertoad
Copy link
Collaborator

Would be amazing!

@philsturgeon
Copy link
Author

Yes please!

@kobik
Copy link
Collaborator

kobik commented Apr 13, 2020

Please review #114

openapi-validation-middleware is already taken in npm so i used openapi-validator-middleware instead

@kobik kobik closed this as completed Apr 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

3 participants