Better 414 Response Error Message #65
Merged
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
thodson-usgs
approved these changes
Dec 20, 2022
elbeejay
added a commit
to elbeejay/dataretrieval-1
that referenced
this pull request
Dec 28, 2022
thodson-usgs
pushed a commit
that referenced
this pull request
Dec 28, 2022
* add hydorshare notebooks to rendered docs * matplotlib for docs * improve some doc-strings * fix nadp url, improve doc-strings, add nadp tests * minor linting * try-except due to gdal on ci * improvements to doc-strings * minor linting * linting waterwatch * doc-string examples, formatting, tests for wqp * ignore link to docs page that doesnt exist yet * linting and doc-strings for streamstats * doc-strings and linting * doc-strings and examples * complete get_record doc-string * fix examples in nwis doc-strings * document data portals (#33) * add county example for water_use (#46) * pseudo-code example for large queries in warning (#65)
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.
This PR closes #64.
It is pretty straightforward, we handle the 414 response case in
query()and print out a custom error message to convey to the user that the API query generated by their function call is too long. Previous error message was not useful to the end-user, per #64.This PR also adds a corresponding unit test which checks that both the expected error type and message are captured when trying to perform a query with a URL that is too long.