Describe Matrix URI scheme #3168
Conversation
Spec for #2312
| There are two major kinds of referring to a resource in Matrix: matrix.to | ||
| and `matrix:` URI. The specification currently defines both as active/valid | ||
| ways to refer to entities/resources. |
There was a problem hiding this comment.
No preference/note of deprecation of the former?
There was a problem hiding this comment.
The MSC didn't deprecate anything
|
|
||
| Note that this format is deliberately following [RFC 3986](https://tools.ietf.org/html/rfc3986) | ||
| to ensure maximum compatibility with existing tooling. This URI scheme is | ||
| registered with the IANA [here](https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml). |
There was a problem hiding this comment.
| registered with the IANA [here](https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml). | |
| registered with the IANA [here](https://www.iana.org/assignments/uri-schemes/prov/matrix). |
There was a problem hiding this comment.
Long term I'd expect that URL to change, so didn't want to have a broken link.
| service - see below for more details. | ||
| During development of this URI format, types of `user`, `room`, and `event` | ||
| were used: these MUST NOT be produced any further, though implementations might | ||
| wish to consider handling them as `u`, `r`, and `e` respectively. |
There was a problem hiding this comment.
| wish to consider handling them as `u`, `r`, and `e` respectively. | |
| wish to consider handling them as `u`, `r`, and `e` respectively. | |
| `roomid` will be used as indicated in development. |
(for exhaustiveness' sake)
There was a problem hiding this comment.
Not sure this is important, honestly. The note isn't meant to be comprehensive, just an indicator that "weird" data might be present
| * Permalink by room: `matrix:r/somewhere:example.org/e/event:example.org` | ||
| * Permalink by room ID: `matrix:roomid/somewhere:example.org/e/event:example.org?via=elsewhere.ca` |
There was a problem hiding this comment.
| * Permalink by room: `matrix:r/somewhere:example.org/e/event:example.org` | |
| * Permalink by room ID: `matrix:roomid/somewhere:example.org/e/event:example.org?via=elsewhere.ca` | |
| * Event permalink by room: `matrix:r/somewhere:example.org/e/abcdef123456` | |
| * Event permalink by room ID (with routing hint): `matrix:roomid/somewhere:example.org/e/abcdef123456?via=elsewhere.ca` |
- "Event" permalink, for explicitness' sake
- utilization of alphanumeric event IDs, as those are the new norm
- "routing hint"
There was a problem hiding this comment.
It's important that we keep the examples as similar as possible between the URIs. The v1 event IDs are clearer and appear less random.
There was a problem hiding this comment.
(though almost a year later v1 event IDs look more confusing to people - will fix)
|
Community members are always welcome to comment on any PR: otherwise we would have made them private :) |
|
I've elected @KitsuneRal for being an author, @richvdh for having a recognisable avatar when counting comments, and @uhoreg for being responsible for registering it with IANA. Any one of the 3 will do, I think. |
Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>
|
Going to close this and make an all-new PR against the main branch. Will bring feedback over with it :) |
With light review being addressed. #3168
Spec for #2312