Endpoint configuration more robust #29
Merged
Conversation
This file contains hidden or 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
michael-groundlight
approved these changes
Mar 16, 2023
Contributor
michael-groundlight
left a comment
michael-groundlight
left a comment
There was a problem hiding this comment.
Awesome! This is helpful
| if parts.path not in ("/device-api/", "/v1/", "/v2/", "/v3/"): | ||
| logger.warning(f"Configured endpoint {endpoint} does not look right - path '{parts.path}' seems wrong.") | ||
| out = urlunsplit(parts) | ||
| out = out[:-1] # remove trailing slash |
Contributor
There was a problem hiding this comment.
Should we log.debug() the sanitized endpoint?
Member
Author
There was a problem hiding this comment.
I'd like to move away from the idea that customers specify /device-api because it's kinda confusing. So I kinda don't even want to expose it in debug logs.
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.
Automatically corrects common mistakes when setting the endpoint URL. Specifically, if you just put a hostname without a path, like
https://api.groundlight.aiit will work properly now (automatically adding/device-api). It corrects for trailing slash on the URL. And warns for URL patterns it doesn't recognize.