Remove return types for paginated endpoints #510
Merged
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.
Changes
Paginated endpoints, like
organizations.all_organization_members
return alist
wheninclude_totals
isNone
orFalse
and adict
wheninclude_totals
isTrue
. Currently the return type of these islist[dict[str, Any]]
and so static type checkers will fail when the developer setsinclude_totals=True
.I've removed the return type for these because:
list[dict[str, Any]]
is not particularly usefultyping-extensions
package (as 3.7 doesn't supporttyping.Literal
), which to change the type to returndict[str, Any]
as well aslist[dict[str, Any]]
is not justified.Type support for this SDK is only very basic at the moment. But we will improve it in the future if/when we can get structured API data (like OpenAPI 3) from the Auth0 Management API.
References
fix #509
Testing
Checklist