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

strict response validation #319

Merged
merged 1 commit into from
Nov 25, 2021
Merged

Conversation

ota42y
Copy link
Member

@ota42y ota42y commented May 15, 2021

This changes break backward compatibility because when the user set strict option, old version is ignore but this version doesn't ignore.
So we should add warning on old version.

close: #317

@ota42y ota42y added this to the 5.0.0 milestone May 15, 2021
@ota42y ota42y force-pushed the feature/strict_response_validation branch from 3a11378 to a5b5fef Compare May 16, 2021 05:02
@nicolasiensen
Copy link
Contributor

Hey @ota42y, what is missing to merge this PR? I would be glad to help.

@ota42y
Copy link
Member Author

ota42y commented Aug 23, 2021

Sorry, there's nothing problem with this PR.
We have not changed master towards 5.0.0 yet, so we can't merge this PR.

Since 5.0.0 is a major version upgrade, we would like to include several breaking changes.
And we are thinking of making a version 4.99.0 that outputs various warnings to users won't have trouble when updating.
In order to do this, we need to decide what changes we want to make in 5.0.0.

committee use openapi_parser gem for validating OpenAPI 3 and I would like to release a major version upgrade (1.0.0) as the same time.
https://github.com/ota42y/openapi_parser

So we should do these step

  1. release openapi_parser 1.0.0
  2. use it in commitee 5.0.0 and add breaking changes
  3. release 4.99.0 for comfortable upgrade
  4. release 5.0.0

In openapi_parser 1.0.0, drop old ruby version.
So we would like to add types and this is not done.
(This is because I add types by manually in many functions)
ota42y/openapi_parser#118

But it's taking too long..., and it's not a functional addition, I think I'll release to using more untyped 🤔

@nicolasiensen
Copy link
Contributor

nicolasiensen commented Aug 24, 2021

Regarding the openapi_parser, do you think it is a good idea to bump the Ruby version and add types in one go? Wouldn't it be more manageable if we bump Ruby first and add types in another version?

Besides bumping Ruby to 3, is there any other breaking change you plan to introduce to the openapi_parser 1.0?

Thanks for the detailed explanation :)

@ota42y
Copy link
Member Author

ota42y commented Sep 5, 2021

My concern was that changing the defined form later would have to be treated as a breaking changes (and we need to update major version).
However, when I examined the version control in typescript, it was the management that the types can be changed frequently even in the same minor version.
As a result, I no longer have to worry about adding a type first and changing it later, so I'm going to release it with the current types.

@nicolasiensen
Copy link
Contributor

That makes sense. Let me know if there is anything I could help with, ok?

@ota42y ota42y force-pushed the feature/strict_response_validation branch from a5b5fef to adc7d9a Compare November 22, 2021 13:54
@ota42y
Copy link
Member Author

ota42y commented Nov 25, 2021

sorry, master branch's version changed 5.0.0, so I merge this PR

@ota42y ota42y merged commit c9b4381 into master Nov 25, 2021
@ota42y ota42y deleted the feature/strict_response_validation branch November 25, 2021 13:49
@ota42y
Copy link
Member Author

ota42y commented Jan 28, 2023

I released 5.0.0 with this changes!
https://rubygems.org/gems/committee/versions/5.0.0

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.

Raise error in strict mode when missing response code
2 participants