[FIX] Allow only `"true"` or `None` for `is_control` query parameter - Githubissues

neurobagel / federation-api

REST API for query federation over multiple Neurobagel graph databases

https://federate.neurobagel.org

MIT License

0 stars 0 forks source link

[FIX] Allow only `"true"` or `None` for `is_control` query parameter #129

Closed alyssadai closed 1 month ago

alyssadai commented 1 month ago

Closes #128
Related to neurobagel/api#364

Changes proposed in this pull request:

is_control query param now accepts str or None, with allowed str values being only "true" (case-insensitive) via custom validation
- note: for the other query params we rely on the n-APIs to do the validation, but since this behaviour for is_control is a bit unintuitive, having basic validation in f-API may help to avoid confusion (for us and users)
valid str values are passed on, as is, to n-APIs

Checklist

This section is for the PR reviewer

[x] PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
[x] PR has a label for the release changelog or skip-release (to be applied by maintainers only)
[x] PR links to GitHub issue with mention Closes #XXXX
[x] Tests pass
[x] Checks pass

For new features:

[x] Tests have been added

For bug fixes:

[x] There is at least one test that would fail under the original bug conditions.

coveralls commented 1 month ago

Pull Request Test Coverage Report for Build 11504603039

Details

21 of 21 (100.0%) changed or added relevant lines in 2 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.09%) to 96.943%

Totals
Change from base Build 11449989011:	0.09%
Covered Lines:	666
Relevant Lines:	687

💛 - Coveralls

neurobagel-bot[bot] commented 1 month ago

:rocket: PR was released in v0.4.0 :rocket: