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

Oad reports added required parameter when it just moved from path to operation #220

Closed
mikekistler opened this issue Jan 31, 2022 · 4 comments

Comments

@mikekistler
Copy link
Member

mikekistler commented Jan 31, 2022

In this PR, oad reports many instances of "AddingRequiredParameter" that are false positives, because the parameter was present and required in the previous version, but was specified at the path level rather than in the operation, as it is in the new version.

While this is a change in the way the API is described, it is not actually a change in the API definition, so should not be reported as a breaking change.

@jianyexi
Copy link
Contributor

jianyexi commented Feb 7, 2022

This is not false alarm, removing the path level parameters is also breaking change

@jianyexi jianyexi closed this as completed Feb 7, 2022
@mikekistler mikekistler reopened this Feb 7, 2022
@mikekistler
Copy link
Member Author

In this case, path parameters were neither added nor removed. They were simply described in a different place.

@mikekistler
Copy link
Member Author

Not sure what is going on -- I've tried to get a simple recreate for this problem but so far I am not successful.

@mikekistler
Copy link
Member Author

I think I may see what is going on. The PR was updated but the PR checks were not marked as "outdated" or updated in place. This makes it look like the current code has problems when in fact the problems were fixed.

If this is correct then we can close this issue but should open one on the pipeline to update the PR checks section in place.

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

No branches or pull requests

2 participants