Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-23 15:53:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clarify that base_url in client well_known may or may not include trailing slash (#3562)

Browse source 
Fixes #3465. The change adds a line explicitly warning developers that the base_url of client well_known may or may not include a trailing slash and to be prepared to handle both cases.
This commit is contained in:
Shay 2021-12-23 02:12:25 -08:00 committed by GitHub
parent 71ff06fd7a
commit 87fcb7c8b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/3562.clarification Normal file
View file

@ -0,0 +1 @@
Clarify that `base_url` in client `well_known` may or may not include trailing slash.

8
content/client-server-api/_index.md
View file

@ -285,10 +285,10 @@ specify parameter values. The flow for this method is as follows:
1. If the content cannot be parsed, then `FAIL_PROMPT`. 1. If the content cannot be parsed, then `FAIL_PROMPT`.
4. Extract the `base_url` value from the `m.homeserver` property. 4. Extract the `base_url` value from the `m.homeserver` property.
This value is to be used as the base URL of the homeserver. This value is to be used as the base URL of the homeserver.
1. If this value is not provided, then `FAIL_PROMPT`. 1. If this value is not provided, then `FAIL_PROMPT`.
5. Validate the homeserver base URL: 5. Validate the homeserver base URL:
1. Parse it as a URL. If it is not a URL, then `FAIL_ERROR`. 1. Parse it as a URL. If it is not a URL, then `FAIL_ERROR`.
2. Clients SHOULD validate that the URL points to a valid 2. Clients SHOULD validate that the URL points to a valid
homeserver before accepting it by connecting to the homeserver before accepting it by connecting to the
[`/_matrix/client/versions`](/client-server-api/#get_matrixclientversions) endpoint, ensuring that it does [`/_matrix/client/versions`](/client-server-api/#get_matrixclientversions) endpoint, ensuring that it does
not return an error, and parsing and validating that the not return an error, and parsing and validating that the
@ -297,6 +297,8 @@ specify parameter values. The flow for this method is as follows:
done as a simple check against configuration errors, in done as a simple check against configuration errors, in
order to ensure that the discovered address points to a order to ensure that the discovered address points to a
valid homeserver. valid homeserver.
3. It is important to note that the `base_url` value might include
a trailing `/`. Consumers should be prepared to handle both cases.
6. If the `m.identity_server` property is present, extract the 6. If the `m.identity_server` property is present, extract the
`base_url` value for use as the base URL of the identity server. `base_url` value for use as the base URL of the identity server.
Validation for this URL is done as in the step above, but using Validation for this URL is done as in the step above, but using