[API] Fix API DICOM get documentation #9458
Open
Conversation
This file contains 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
maximemulder
force-pushed
the
2024-11-07_api-dicom-get-doc-fix
branch
from
0b6f7b8
to
726454b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Extracted from #9154.
Brief summary of changes
The current documentation does not match the behavior of the DICOM get endpoint. The documentation says it returns a string, whereas the endpoint actually returns an int. @driusan makes a point that it might either be the code or the documentation that is wrong (message). I personally think an integer ID should be encoded as an int, but this is not a strong opinion.