Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abstract away inconsistency of empty results #17

Open
markembling opened this issue Apr 18, 2019 · 0 comments
Open

Abstract away inconsistency of empty results #17

markembling opened this issue Apr 18, 2019 · 0 comments
Milestone

Comments

@markembling
Copy link
Owner

markembling commented Apr 18, 2019

Currently the API returns null for some query endpoints where no results/matches exist, and for others it returns []. This can't be changed for backwards-compatibility reasons (see ideal-postcodes/postcodes.io#319).

However it makes sense in the context of this client to abstract that away and handle empties in a more predictable way (i.e. always returning an empty IEnumerable<T>). This will be more consistent for devs using this client library. This will be a backwards-incompatible change, so needs to tie to v1.x.

The ability to opt out of normalising empty results and back into API-consistent behaviour (3a/3b in the linked discussion, where results will come back as null where the API gives that) should probably also be added.

@markembling markembling added this to the v1.0.0 milestone Apr 18, 2019
markembling added a commit that referenced this issue Apr 21, 2019
RequestExecutor is now tested (apart from some async behaviour which is
still outstanding). When dealing with a collection as the return type
for the request, if null is receieved from the server, an empty
collection of the appropriate type is returned instead. This fixes #17.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant