Prepare for v0.1.0 release #43
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
rsjethani
force-pushed
the
36-prepare-for-v010-release
branch
3 times, most recently
from
2e16dbf
to
11ff1de
Compare
StefMa
previously approved these changes
Aug 11, 2023
internal/common/common.go
Outdated
| @@ -12,6 +12,10 @@ func HdrValueAuthorization(key string) string { | |||
| return "Bearer " + key | |||
| } | |||
|
|
|||
| func BasePath(server string) string { | |||
There was a problem hiding this comment.
This is not a path 🤔
This is a full URI what we return here.
Given that the server string is a valid URL 🙃
We can improve this later by checking this for an valid URL 👍
However, for now I just want to rename it.
Something like ServerApiUrl? 🤔 Or something... Path feels wrong here...
There was a problem hiding this comment.
Well first of all too much checking and validations obscure the business logic. IMO it should be the responsibility of the user to make sure httttttp://he/is/not/passing/invalid/url 😄 . This aligns with our goal of keeping our API and CLI as just thin wrappers.
But yes the function name is not apt but then IMO the new name BaseURL is more apt because we will be extending it.
The `client.New()` now takes just the outline api server URL and creates base path internally freeing user from the burden of crafting proper base path. The change is also reflected in the `cli` where we also simplify global flags to `--server` and `--key`. Update README accordingly.
rsjethani
force-pushed
the
36-prepare-for-v010-release
branch
from
11ff1de
to
8539c92
Compare
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.
The
client.New()now takes just the outline api server URL and creates base path internally freeing user from the burden of crafting proper base path.The change is also reflected in the
cliwhere we also simplify global flags to--serverand--key.Updated README accordingly.