docs(gitlab): Update the comment about url encoding #36
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
Other parts of the GitLab API use the user and repo names without URL encoding, so there really is no need to encode *those*. Thus, the only remaining part that needs encoding, is the `/` path separator, which we manually url-encoded to `%2F`. If we encoded the user and repo too, that might lead to surprising results later down the line. To not hide problems, leaving them as-is is the preferable way. Update the comment on `Gitlab::get_api_releases_url` accordingly. Fixes #12. Signed-off-by: Gergely Nagy <me@gergo.csillger.hu>
|
Rebased on main |
cafkafk
approved these changes
Nov 3, 2023
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.
Other parts of the GitLab API use the user and repo names without URL encoding, so there really is no need to encode those. Thus, the only remaining part that needs encoding, is the
/path separator, which we manually url-encoded to%2F.If we encoded the user and repo too, that might lead to surprising results later down the line. To not hide problems, leaving them as-is is the preferable way.
Update the comment on
gitlab_api_get_releasesaccordingly.Fixes #12.