mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-04-17 00:24:10 +02:00
Compare commits
3 commits
991139634c
...
627895b33b
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
627895b33b | ||
|
|
f82d8ab15b | ||
|
|
35eb6e1d2b |
|
|
@ -0,0 +1 @@
|
|||
Additional OpenGraph properties can be present in URL previews.
|
||||
|
|
@ -458,25 +458,31 @@ In summary:
|
|||
|
||||
Unstable endpoints MUST use `/unstable` as the endpoint version and a
|
||||
vendor prefix in Java package naming format. For example:
|
||||
`/_matrix/client/unstable/org.matrix.mscxxxx/login`. The foundation's
|
||||
preferred vendor prefix is `org.matrix`.
|
||||
`/_matrix/client/unstable/com.example.mscxxxx/login`.
|
||||
|
||||
{{% boxes/note %}}
|
||||
Proposal authors operating with a Matrix.org Foundation mandate SHOULD use
|
||||
a vendor prefix within the `org.matrix` namespace. This namespace is otherwise
|
||||
restricted. Authors who don't own a domain MAY use the `com.github` namespace
|
||||
instead.
|
||||
{{% /boxes/note %}}
|
||||
|
||||
Note that unstable namespaces do not automatically inherit endpoints from
|
||||
stable namespaces: for example, the fact that `/_matrix/client/v3/sync`
|
||||
exists does not imply that `/_matrix/client/unstable/org.matrix.mscxxxx/sync`
|
||||
exists does not imply that `/_matrix/client/unstable/com.example.mscxxxx/sync`
|
||||
exists.
|
||||
|
||||
Vendor prefixes MUST also be used for:
|
||||
|
||||
- New parameters on existing endpoints. For example:
|
||||
`/_matrix/client/v3/publicRooms?org.matrix.mscxxxx.ordered_by=member_count`.
|
||||
`/_matrix/client/v3/publicRooms?com.example.mscxxxx.ordered_by=member_count`.
|
||||
- New properties in existing JSON objects. For example:
|
||||
|
||||
```json
|
||||
{
|
||||
"avatar_url": "mxc://matrix.org/SDGdghriugerRg",
|
||||
"displayname": "Alice Margatroid",
|
||||
"org.matrix.mscxxxx.phone": [{
|
||||
"com.example.mscxxxx.phone": [{
|
||||
"type": "landline",
|
||||
"number": "+1-206-555-7000"
|
||||
}],
|
||||
|
|
@ -487,7 +493,7 @@ Vendor prefixes MUST also be used for:
|
|||
|
||||
```json
|
||||
{
|
||||
"errcode": "ORG.MATRIX.MSCXXXX.M_INVALID_EMAIL",
|
||||
"errcode": "COM.EXAMPLE.MSCXXXX.M_INVALID_EMAIL",
|
||||
"error": "The email address you provided is invalid."
|
||||
}
|
||||
```
|
||||
|
|
@ -496,13 +502,13 @@ If the client needs to be sure the server supports the feature, an
|
|||
unstable feature flag that MUST also be vendor prefixed is to be used.
|
||||
This flag shows up in the `unstable_features` section of
|
||||
[`/_matrix/client/versions`](/client-server-api/#get_matrixclientversions)
|
||||
as, for example, `org.matrix.mscxxxx.new_login`.
|
||||
as, for example, `com.example.mscxxxx.new_login`.
|
||||
|
||||
{{% boxes/note %}}
|
||||
MSCs MUST still describe what the stable endpoints/feature looks like
|
||||
with a note towards the bottom for what the unstable feature
|
||||
flag/prefixes are. For example, an MSC would propose `/_matrix/client/v1/new/endpoint`,
|
||||
not `/_matrix/client/unstable/org.matrix.mscxxxx/new/endpoint`.
|
||||
not `/_matrix/client/unstable/com.example.mscxxxx/new/endpoint`.
|
||||
{{% /boxes/note %}}
|
||||
|
||||
When using this approach correctly, the implementation can release
|
||||
|
|
|
|||
|
|
@ -379,7 +379,8 @@ paths:
|
|||
description: |-
|
||||
The OpenGraph data for the URL, which may be empty. Some values are
|
||||
replaced with matrix equivalents if they are provided in the response.
|
||||
The differences from the OpenGraph protocol are described here.
|
||||
The differences from the [OpenGraph protocol](https://ogp.me/) are
|
||||
described here.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
|
|
@ -394,6 +395,9 @@ paths:
|
|||
format: uri
|
||||
description: An [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) to
|
||||
the image. Omitted if there is no image.
|
||||
additionalProperties:
|
||||
description: |-
|
||||
Additional properties as per the [OpenGraph](https://ogp.me/) protocol.
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
|
|
|
|||
|
|
@ -605,7 +605,8 @@ paths:
|
|||
description: |-
|
||||
The OpenGraph data for the URL, which may be empty. Some values are
|
||||
replaced with matrix equivalents if they are provided in the response.
|
||||
The differences from the OpenGraph protocol are described here.
|
||||
The differences from the [OpenGraph](https://ogp.me/) protocol are
|
||||
described here.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
|
|
@ -620,6 +621,9 @@ paths:
|
|||
format: uri
|
||||
description: An [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) to
|
||||
the image. Omitted if there is no image.
|
||||
additionalProperties:
|
||||
description: |-
|
||||
Additional properties as per the [OpenGraph](https://ogp.me/) protocol.
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
|
|
|
|||
Loading…
Reference in a new issue