Fix documentation mismatch on api.find_first TheHive-Project/TheHive4py#165 #166
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
|
Hello @haam3r thanks for the PR, the issue here is that this breaks compatibility. The original We need to be careful about it. |
|
Okay, that's understandable. Would you like me to change the PR in some way? |
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.
Fixes: #165
api.find_firstfunction to return arequests.Responseobject instead of a Python dict as it should be according to the docstrings.requests.Responseobject.This PR changes the logic by overwriting the
rangeparameter to0-1which means we actually ask The Hive to only provide one case.rangeparameter from the docstrings Arguments list, since we now set it statically.