Clarify that base_url in client well_known may or may not include trailing slash
#3562
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
turt2live
reviewed
Dec 9, 2021
|
So I didn't help,I made something work or not??? Humm
…On Wed, Dec 8, 2021, 8:25 PM Travis Ralston ***@***.***> wrote:
***@***.**** commented on this pull request.
Overall looks fine - can we get a changelog please? :)
------------------------------
In content/client-server-api/_index.md
<#3562 (comment)>
:
> + 2. It is important to note that this value may or may not include
+ a trailing `/`. Consumers should be prepared to handle both
+ cases.
We've found that "may" introduces more confusion than not in the formal
spec:
⬇️ Suggested change
- 2. It is important to note that this value may or may not include
- a trailing `/`. Consumers should be prepared to handle both
- cases.
+ 2. It is important to note that this value might not include
+ a trailing `/`. Consumers should be prepared to handle both
+ cases.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#3562 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMXLIEVRZTUUYTBH7SZ3H63UQAHSFANCNFSM5JU2GDLA>
.
|
|
Sorry @shenanigans77-jpg, I'm not sure what you mean? |
richvdh
reviewed
Dec 21, 2021
content/client-server-api/_index.md
Outdated
Comment on lines
289
to
290
| 2. It is important to note that this value might include a trailing | ||
| `/`. Consumers should be prepared to handle both cases. |
There was a problem hiding this comment.
I think we need to move this a bit further down - it doesn't seem to make much sense to talk about trailing slashes before validating it as a URL?
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.
Fixes #3465. The change adds a line explicitly warning developers that the
base_urlof clientwell_knownmay or may not include a trailing slash and to be prepared to handle both cases.Preview: https://pr3562--matrix-org-previews.netlify.app