Add docstrings to API - #112
Open
Yannicked wants to merge 2 commits into
Open
Conversation
Yannicked
requested review from
SimonPinches,
maarten-ic,
olivhoenen and
prasad-sawantdesai
as code owners
July 30, 2026 09:06
olivhoenen
approved these changes
Jul 30, 2026
olivhoenen
left a comment
olivhoenen
left a comment
Contributor
There was a problem hiding this comment.
Thanks a lot, this is much appreciated! Please just simplify the one case I found with duplication of into between endpoint level and its argument description.
| constraint = parse_query_arg(value) | ||
| if constraint[0] or constraint[1] == QueryType.EXIST: | ||
| constraints.append((name, *constraint)) | ||
| """List simulations, optionally filtered by metadata. |
Contributor
There was a problem hiding this comment.
Some of the description here enters too much into details as is a duplication of info w.r.t parameters you describe in line 172
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds docstrings to the existing API endpoints. These are displayed in the generated swagger documentation