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.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Bug fix
What is the current behavior? (You can also link to an open issue here)
Currently get_indexes returns a dictionary of str and list of Index objects. The docstring and the REST API however return a dictionary of str and a list of dicts of str and str.
e.g. the python client returns
Where the REST API returns
The new behaviour is to have
get_indexes()
return the same structure as the REST APIThis PR does break the use case where users use the
Index
objects returned fromget_indexes()
.e.g.
However this usage pattern is never documented anywhere or used in any examples as far as I can see. It only appears in one of the tests for the
get_indexes()
method.This changes means that you can print the results as dictionaries have
__repr__
.An alternative would be to add
__getitem__
and__repr__
to the index object to retain both the existing functionality and let users treat it like a dict. e.g.