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

Incorrect documentation of API parameters #13215

Closed
crazyscientist opened this issue Oct 14, 2022 · 1 comment · Fixed by #13984
Closed

Incorrect documentation of API parameters #13215

crazyscientist opened this issue Oct 14, 2022 · 1 comment · Fixed by #13984

Comments

@crazyscientist
Copy link

Issue Description

After #9715 explained the difference between a "boolean flag" parameter and "boolean value" parameters, the issue was closed with the reason that the parameters of the /source/<project> endpoint are boolean and documented as such.

Unfortunately, these parameters are not declared as boolean:

image

Expected Result

Any boolean flag parameter (i.e. true, if present, and false otherwise) of any endpoint should be declared as such.1

Footnotes

  1. For clients interacting with the API directly, it is very frustrating: One has to figure out this distinction by trial and error.

@bmwiedemann
Copy link
Member

Please review #13984

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 a pull request may close this issue.

2 participants