improve Typesense client exception semantics #70
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.
Note
Breaking changes!
This update will result in breaking changes for clients that used null checks to see if a resource existed or not. The new implementation will throw an
TypesenseApiNotFoundException
instead, the benefit is that the API will be more uniform overall.Change
Now provides a range of more specific exceptions. The reason is to improve error-handling. Instead of only having
TypesenseApiException
, the client now has a range of exception types all inheriting fromTypesenseApiException
, so if you're already catchingTypesenseApiException
, you won't have to change anything. The error types has been taken from Typesense documentation regarding API errors link.TypesenseApiException
TypesenseApiBadRequestException
TypesenseApiUnauthorizedException
TypesenseApiNotFoundException
TypesenseApiConflictException
TypesenseApiUnprocessableEntityException
TypesenseApiServiceUnavailableException