wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add a hyphen between third and party when used as an adjective (#1447)

Browse source
This commit is contained in:
Andrew Morgan 2023-03-08 09:58:29 +00:00 • committed by GitHub
parent 9ebcf5f257
commit c0955a6aee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
37 changed files with 190 additions and 187 deletions
Download patch file Download diff file Expand all files Collapse all files

4
data/api/application-service/definitions/location.yaml
View file

@ -17,11 +17,11 @@ properties:
type: string
example: "#freenode_#matrix:matrix.org"
protocol:
description: The protocol ID that the third party location is a part of.
description: The protocol ID that the third-party location is a part of.
type: string
example: "irc"
fields:
description: Information used to identify this third party location.
description: Information used to identify this third-party location.
type: object
example: {
"network": "freenode",

2
data/api/application-service/definitions/location_batch.yaml
View file

@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
type: array
description: List of matched third party locations.
description: List of matched third-party locations.
items:
$ref: location.yaml

10
data/api/application-service/definitions/protocol.yaml
View file

@ -16,28 +16,28 @@ type: object
properties:
user_fields:
description: |-
Fields which may be used to identify a third party user. These should be
Fields which may be used to identify a third-party user. These should be
ordered to suggest the way that entities may be grouped, where higher
groupings are ordered first. For example, the name of a network should be
searched before the nickname of a user.
type: array
items:
type: string
description: Field used to identify a third party user.
description: Field used to identify a third-party user.
example: ["network", "nickname"]
location_fields:
description: |-
Fields which may be used to identify a third party location. These should be
Fields which may be used to identify a third-party location. These should be
ordered to suggest the way that entities may be grouped, where higher
groupings are ordered first. For example, the name of a network should be
searched before the name of a channel.
type: array
items:
type: string
description: Field used to identify a third party location.
description: Field used to identify a third-party location.
example: ["network", "channel"]
icon:
description: A content URI representing an icon for the third party protocol.
description: A content URI representing an icon for the third-party protocol.
type: string
example: "mxc://example.org/aBcDeFgH"
field_types:

2
data/api/application-service/definitions/protocol_metadata.yaml
View file

@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
type: object
description: Dictionary of supported third party protocols.
description: Dictionary of supported third-party protocols.
additionalProperties:
$ref: protocol.yaml
example: {

6
data/api/application-service/definitions/user.yaml
View file

@ -15,15 +15,15 @@
# TODO: Change userid to user_id as a breaking change
properties:
userid:
description: A Matrix User ID represting a third party user.
description: A Matrix User ID represting a third-party user.
type: string
example: "@_gitter_jim:matrix.org"
protocol:
description: The protocol ID that the third party location is a part of.
description: The protocol ID that the third-party location is a part of.
type: string
example: "gitter"
fields:
description: Information used to identify this third party location.
description: Information used to identify this third-party location.
type: object
example: {
"user": "jim"

2
data/api/application-service/definitions/user_batch.yaml
View file

@ -12,6 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
type: array
description: List of matched third party users.
description: List of matched third-party users.
items:
$ref: user.yaml

24
data/api/application-service/protocols.yaml
View file

@ -32,7 +32,7 @@ paths:
summary: Retrieve metadata about a specific protocol that the application service supports.
description: |-
This API is called by the homeserver when it wants to present clients
with specific information about the various third party networks that
with specific information about the various third-party networks that
an application service supports.
operationId: getProtocolMetadata
security:
@ -78,10 +78,10 @@ paths:
$ref: ../client-server/definitions/errors/error.yaml
"/thirdparty/user/{protocol}":
get:
summary: Retrieve the Matrix User ID of a corresponding third party user.
summary: Retrieve the Matrix User ID of a corresponding third-party user.
description: |-
This API is called by the homeserver in order to retrieve a Matrix
User ID linked to a user on the third party network, given a set of
User ID linked to a user on the third-party network, given a set of
user parameters.
operationId: queryUserByProtocol
security:
@ -133,9 +133,9 @@ paths:
$ref: ../client-server/definitions/errors/error.yaml
"/thirdparty/location/{protocol}":
get:
summary: Retrieve Matrix-side portal rooms leading to a third party location.
summary: Retrieve Matrix-side portal rooms leading to a third-party location.
description: |-
Retrieve a list of Matrix portal rooms that lead to the matched third party location.
Retrieve a list of Matrix portal rooms that lead to the matched third-party location.
operationId: queryLocationByProtocol
security:
- homeserverAccessToken: []
@ -151,7 +151,7 @@ paths:
type: string
description: |-
One or more custom fields that are passed to the application
service to help identify the third party location.
service to help identify the third-party location.
responses:
200:
description: At least one portal room was found.
@ -186,9 +186,9 @@ paths:
$ref: ../client-server/definitions/errors/error.yaml
"/thirdparty/location":
get:
summary: Reverse-lookup third party locations given a Matrix room alias.
summary: Reverse-lookup third-party locations given a Matrix room alias.
description: |-
Retrieve an array of third party network locations from a Matrix room
Retrieve an array of third-party network locations from a Matrix room
alias.
operationId: queryLocationByAlias
security:
@ -201,7 +201,7 @@ paths:
responses:
200:
description: |-
All found third party locations.
All found third-party locations.
schema:
$ref: definitions/location_batch.yaml
401:
@ -233,9 +233,9 @@ paths:
$ref: ../client-server/definitions/errors/error.yaml
"/thirdparty/user":
get:
summary: Reverse-lookup third party users given a Matrix User ID.
summary: Reverse-lookup third-party users given a Matrix User ID.
description: |-
Retrieve an array of third party users from a Matrix User ID.
Retrieve an array of third-party users from a Matrix User ID.
operationId: queryUserByID
security:
- homeserverAccessToken: []
@ -247,7 +247,7 @@ paths:
responses:
200:
description: |-
An array of third party users.
An array of third-party users.
schema:
$ref: definitions/user_batch.yaml
401:

54
data/api/client-server/administrative_contact.yaml
View file

@ -30,12 +30,12 @@ securityDefinitions:
paths:
"/account/3pid":
get:
summary: Gets a list of a user's third party identifiers.
summary: Gets a list of a user's third-party identifiers.
description: |-
Gets a list of the third party identifiers that the homeserver has
Gets a list of the third-party identifiers that the homeserver has
associated with the user's account.
This is *not* the same as the list of third party identifiers bound to
This is *not* the same as the list of third-party identifiers bound to
the user's Matrix ID in identity servers.
Identifiers in this list may be used by the homeserver as, for example,
@ -64,15 +64,15 @@ paths:
type: array
items:
type: object
title: Third party identifier
title: Third-party identifier
properties:
medium:
type: string
description: The medium of the third party identifier.
description: The medium of the third-party identifier.
enum: ["email", "msisdn"]
address:
type: string
description: The third party identifier address.
description: The third-party identifier address.
validated_at:
type: integer
format: int64
@ -84,7 +84,7 @@ paths:
format: int64
description:
The timestamp, in milliseconds, when the homeserver
associated the third party identifier with the user.
associated the third-party identifier with the user.
required: ['medium', 'address', 'validated_at', 'added_at']
tags:
- Account management
@ -115,7 +115,7 @@ paths:
three_pid_creds:
title: "ThreePidCredentials"
type: object
description: The third party credentials to associate with the account.
description: The third-party credentials to associate with the account.
properties:
client_secret:
type: string
@ -174,7 +174,7 @@ paths:
examples:
application/json: {
"errcode": "M_THREEPID_AUTH_FAILED",
"error": "The third party credentials could not be verified by the identity server."
"error": "The third-party credentials could not be verified by the identity server."
}
schema:
"$ref": "definitions/errors/error.yaml"
@ -290,9 +290,9 @@ paths:
- Account management
"/account/3pid/delete":
post:
summary: Deletes a third party identifier from the user's account
summary: Deletes a third-party identifier from the user's account
description: |-
Removes a third party identifier from the user's account. This might not
Removes a third-party identifier from the user's account. This might not
cause an unbind of the identifier from the identity server.
Unlike other endpoints, this endpoint does not take an `id_access_token`
@ -318,18 +318,18 @@ paths:
example: "example.org"
medium:
type: string
description: The medium of the third party identifier being removed.
description: The medium of the third-party identifier being removed.
enum: ["email", "msisdn"]
example: "email"
address:
type: string
description: The third party address being removed.
description: The third-party address being removed.
example: "example@example.org"
required: ['medium', 'address']
responses:
200:
description: |-
The homeserver has disassociated the third party identifier from the
The homeserver has disassociated the third-party identifier from the
user.
schema:
type: object
@ -355,9 +355,9 @@ paths:
- Account management
"/account/3pid/unbind":
post:
summary: Removes a user's third party identifier from an identity server.
summary: Removes a user's third-party identifier from an identity server.
description: |-
Removes a user's third party identifier from the provided identity server
Removes a user's third-party identifier from the provided identity server
without removing it from the homeserver.
Unlike other endpoints, this endpoint does not take an `id_access_token`
@ -383,18 +383,18 @@ paths:
example: "example.org"
medium:
type: string
description: The medium of the third party identifier being removed.
description: The medium of the third-party identifier being removed.
enum: ["email", "msisdn"]
example: "email"
address:
type: string
description: The third party address being removed.
description: The third-party address being removed.
example: "example@example.org"
required: ['medium', 'address']
responses:
200:
description: |-
The identity server has disassociated the third party identifier from the
The identity server has disassociated the third-party identifier from the
user.
schema:
type: object
@ -446,18 +446,18 @@ paths:
$ref: "definitions/request_token_response.yaml"
403:
description: |-
The homeserver does not allow the third party identifier as a
The homeserver does not allow the third-party identifier as a
contact option.
schema:
$ref: "definitions/errors/error.yaml"
examples:
application/json: {
"errcode": "M_THREEPID_DENIED",
"error": "Third party identifier is not allowed"
"error": "Third-party identifier is not allowed"
}
400:
description: |-
The third party identifier is already in use on the homeserver, or
The third-party identifier is already in use on the homeserver, or
the request was invalid. The error code `M_SERVER_NOT_TRUSTED`
can be returned if the server does not trust/support the identity server
provided in the request.
@ -466,7 +466,7 @@ paths:
examples:
application/json: {
"errcode": "M_THREEPID_IN_USE",
"error": "Third party identifier already in use"
"error": "Third-party identifier already in use"
}
tags:
- Account management
@ -496,18 +496,18 @@ paths:
$ref: "definitions/request_token_response.yaml"
403:
description: |-
The homeserver does not allow the third party identifier as a
The homeserver does not allow the third-party identifier as a
contact option.
schema:
$ref: "definitions/errors/error.yaml"
examples:
application/json: {
"errcode": "M_THREEPID_DENIED",
"error": "Third party identifier is not allowed"
"error": "Third-party identifier is not allowed"
}
400:
description: |-
The third party identifier is already in use on the homeserver, or
The third-party identifier is already in use on the homeserver, or
the request was invalid. The error code `M_SERVER_NOT_TRUSTED`
can be returned if the server does not trust/support the identity server
provided in the request.
@ -516,7 +516,7 @@ paths:
examples:
application/json: {
"errcode": "M_THREEPID_IN_USE",
"error": "Third party identifier already in use"
"error": "Third-party identifier already in use"
}
tags:
- Account management

6
data/api/client-server/create_room.yaml
View file

@ -138,7 +138,7 @@ paths:
invite_3pid:
type: array
description: |-
A list of objects representing third party IDs to invite into
A list of objects representing third-party IDs to invite into
the room.
items:
type: object
@ -146,7 +146,7 @@ paths:
properties:
id_server:
type: string
description: The hostname+port of the identity server which should be used for third party identifier lookups.
description: The hostname+port of the identity server which should be used for third-party identifier lookups.
id_access_token:
type: string
description: |-
@ -160,7 +160,7 @@ paths:
(see [the list of recognised values](/appendices/#3pid-types)).
address:
type: string
description: The invitee's third party identifier.
description: The invitee's third-party identifier.
required: ["id_server", "id_access_token", "medium", "address"]
room_version:
type: string

4
data/api/client-server/definitions/third_party_signed.yaml
View file

@ -12,10 +12,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.
type: object
title: Third Party Signed
title: Third-party Signed
description: |-
A signature of an `m.third_party_invite` token to prove that this user
owns a third party identity which has been invited to the room.
owns a third-party identity which has been invited to the room.
properties:
sender:
type: string

2
data/api/client-server/inviting.yaml
View file

@ -36,7 +36,7 @@ paths:
*Note that there are two forms of this API, which are documented separately.
This version of the API requires that the inviter knows the Matrix
identifier of the invitee. The other is documented in the
[third party invites](/client-server-api/#third-party-invites) section.*
[third-party invites](/client-server-api/#third-party-invites) section.*
This API invites a user to participate in a particular room.
They do not start participating in the room until they actually join the

2
data/api/client-server/list_public_rooms.yaml
View file

@ -219,7 +219,7 @@ paths:
third_party_instance_id:
type: string
description: |-
The specific third party network/protocol to request from the
The specific third-party network/protocol to request from the
homeserver. Can only be used if `include_all_networks` is false.
example: "irc"
example: {

4
data/api/client-server/login.yaml
View file

@ -107,10 +107,10 @@ paths:
description: The fully qualified user ID or just local part of the user ID, to log in. Deprecated in favour of `identifier`.
medium:
type: string
description: When logging in using a third party identifier, the medium of the identifier. Must be 'email'. Deprecated in favour of `identifier`.
description: When logging in using a third-party identifier, the medium of the identifier. Must be 'email'. Deprecated in favour of `identifier`.
address:
type: string
description: Third party identifier for the user. Deprecated in favour of `identifier`.
description: Third-party identifier for the user. Deprecated in favour of `identifier`.
password:
type: string
description: |-

16
data/api/client-server/registration.yaml
View file

@ -272,7 +272,7 @@ paths:
examples:
application/json: {
"errcode": "M_THREEPID_DENIED",
"error": "Third party identifier is not allowed"
"error": "Third-party identifier is not allowed"
}
400:
description: |-
@ -324,7 +324,7 @@ paths:
examples:
application/json: {
"errcode": "M_THREEPID_DENIED",
"error": "Third party identifier is not allowed"
"error": "Third-party identifier is not allowed"
}
400:
description: |-
@ -443,18 +443,18 @@ paths:
$ref: "definitions/request_token_response.yaml"
403:
description: |-
The homeserver does not allow the third party identifier as a
The homeserver does not allow the third-party identifier as a
contact option.
schema:
$ref: "definitions/errors/error.yaml"
examples:
application/json: {
"errcode": "M_THREEPID_DENIED",
"error": "Third party identifier is not allowed"
"error": "Third-party identifier is not allowed"
}
400:
description: |-
The referenced third party identifier is not recognised by the
The referenced third-party identifier is not recognised by the
homeserver, or the request was invalid. The error code `M_SERVER_NOT_TRUSTED`
can be returned if the server does not trust/support the identity server
provided in the request.
@ -500,18 +500,18 @@ paths:
$ref: "definitions/request_token_response.yaml"
403:
description: |-
The homeserver does not allow the third party identifier as a
The homeserver does not allow the third-party identifier as a
contact option.
schema:
$ref: "definitions/errors/error.yaml"
examples:
application/json: {
"errcode": "M_THREEPID_DENIED",
"error": "Third party identifier is not allowed"
"error": "Third-party identifier is not allowed"
}
400:
description: |-
The referenced third party identifier is not recognised by the
The referenced third-party identifier is not recognised by the
homeserver, or the request was invalid. The error code `M_SERVER_NOT_TRUSTED`
can be returned if the server does not trust/support the identity server
provided in the request.

42
data/api/client-server/third_party_lookup.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Client-Server Third Party Lookup API"
title: "Matrix Client-Server Third-party Lookup API"
version: "1.0.0"
host: localhost:8008
schemes:
@ -43,12 +43,12 @@ paths:
schema:
$ref: ../application-service/definitions/protocol_metadata.yaml
tags:
- Third Party Lookup
- Third-party Lookup
"/thirdparty/protocol/{protocol}":
get:
summary: Retrieve metadata about a specific protocol that the homeserver supports.
description: |-
Fetches the metadata from the homeserver about a particular third party protocol.
Fetches the metadata from the homeserver about a particular third-party protocol.
operationId: getProtocolMetadata
security:
- accessToken: []
@ -74,16 +74,16 @@ paths:
schema:
$ref: definitions/errors/error.yaml
tags:
- Third Party Lookup
- Third-party Lookup
"/thirdparty/location/{protocol}":
get:
summary: Retrieve Matrix-side portals rooms leading to a third party location.
summary: Retrieve Matrix-side portals rooms leading to a third-party location.
description: |-
Requesting this endpoint with a valid protocol name results in a list
of successful mapping results in a JSON array. Each result contains
objects to represent the Matrix room or rooms that represent a portal
to this third party network. Each has the Matrix room alias string,
an identifier for the particular third party network protocol, and an
to this third-party network. Each has the Matrix room alias string,
an identifier for the particular third-party network protocol, and an
object containing the network-specific fields that comprise this
identifier. It should attempt to canonicalise the identifier as much
as reasonably possible given the network type.
@ -94,14 +94,14 @@ paths:
- in: path
name: protocol
type: string
description: The protocol used to communicate to the third party network.
description: The protocol used to communicate to the third-party network.
required: true
x-example: irc
- in: query
name: searchFields
type: string
description: |-
One or more custom fields to help identify the third party
One or more custom fields to help identify the third-party
location.
responses:
200:
@ -117,12 +117,12 @@ paths:
schema:
$ref: definitions/errors/error.yaml
tags:
- Third Party Lookup
- Third-party Lookup
"/thirdparty/user/{protocol}":
get:
summary: Retrieve the Matrix User ID of a corresponding third party user.
summary: Retrieve the Matrix User ID of a corresponding third-party user.
description: |-
Retrieve a Matrix User ID linked to a user on the third party service, given
Retrieve a Matrix User ID linked to a user on the third-party service, given
a set of user parameters.
operationId: queryUserByProtocol
security:
@ -154,12 +154,12 @@ paths:
schema:
$ref: definitions/errors/error.yaml
tags:
- Third Party Lookup
- Third-party Lookup
"/thirdparty/location":
get:
summary: Reverse-lookup third party locations given a Matrix room alias.
summary: Reverse-lookup third-party locations given a Matrix room alias.
description: |-
Retrieve an array of third party network locations from a Matrix room
Retrieve an array of third-party network locations from a Matrix room
alias.
operationId: queryLocationByAlias
security:
@ -174,7 +174,7 @@ paths:
responses:
200:
description: |-
All found third party locations.
All found third-party locations.
schema:
$ref: ../application-service/definitions/location_batch.yaml
404:
@ -186,12 +186,12 @@ paths:
schema:
$ref: definitions/errors/error.yaml
tags:
- Third Party Lookup
- Third-party Lookup
"/thirdparty/user":
get:
summary: Reverse-lookup third party users given a Matrix User ID.
summary: Reverse-lookup third-party users given a Matrix User ID.
description: |-
Retrieve an array of third party users from a Matrix User ID.
Retrieve an array of third-party users from a Matrix User ID.
operationId: queryUserByID
security:
- accessToken: []
@ -205,7 +205,7 @@ paths:
responses:
200:
description: |-
An array of third party users.
An array of third-party users.
schema:
$ref: ../application-service/definitions/user_batch.yaml
404:
@ -217,4 +217,4 @@ paths:
schema:
$ref: definitions/errors/error.yaml
tags:
- Third Party Lookup
- Third-party Lookup

18
data/api/client-server/third_party_membership.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
swagger: '2.0'
info:
title: "Matrix Client-Server Room Membership API for third party identifiers"
title: "Matrix Client-Server Room Membership API for third-party identifiers"
version: "1.0.0"
host: localhost:8008
schemes:
@ -33,9 +33,9 @@ paths:
description: |-
*Note that there are two forms of this API, which are documented separately.
This version of the API does not require that the inviter know the Matrix
identifier of the invitee, and instead relies on third party identifiers.
identifier of the invitee, and instead relies on third-party identifiers.
The homeserver uses an identity server to perform the mapping from
third party identifier to a Matrix identifier. The other is documented in the*
third-party identifier to a Matrix identifier. The other is documented in the*
[joining rooms section](/client-server-api/#post_matrixclientv3roomsroomidinvite).
This API invites a user to participate in a particular room.
@ -46,18 +46,18 @@ paths:
join that room.
If the identity server did know the Matrix user identifier for the
third party identifier, the homeserver will append a `m.room.member`
third-party identifier, the homeserver will append a `m.room.member`
event to the room.
If the identity server does not know a Matrix user identifier for the
passed third party identifier, the homeserver will issue an invitation
which can be accepted upon providing proof of ownership of the third
passed third-party identifier, the homeserver will issue an invitation
which can be accepted upon providing proof of ownership of the third-
party identifier. This is achieved by the identity server generating a
token, which it gives to the inviting homeserver. The homeserver will
add an `m.room.third_party_invite` event into the graph for the room,
containing that token.
When the invitee binds the invited third party identifier to a Matrix
When the invitee binds the invited third-party identifier to a Matrix
user ID, the identity server will give the user a list of pending
invitations, each containing:
@ -96,7 +96,7 @@ paths:
properties:
id_server:
type: string
description: The hostname+port of the identity server which should be used for third party identifier lookups.
description: The hostname+port of the identity server which should be used for third-party identifier lookups.
id_access_token:
type: string
description: |-
@ -110,7 +110,7 @@ paths:
`email` (see [the list of recognised values](/appendices/#3pid-types)).
address:
type: string
description: The invitee's third party identifier.
description: The invitee's third-party identifier.
required: ["id_server", "id_access_token", "medium", "address"]
responses:
200:

4
data/api/server-server/public_rooms.yaml
View file

@ -60,7 +60,7 @@ paths:
name: third_party_instance_id
type: string
description: |-
The specific third party network/protocol to request from the homeserver.
The specific third-party network/protocol to request from the homeserver.
Can only be used if `include_all_networks` is false.
x-example: "irc"
responses:
@ -131,7 +131,7 @@ paths:
third_party_instance_id:
type: string
description: |-
The specific third party network/protocol to request from the
The specific third-party network/protocol to request from the
homeserver. Can only be used if `include_all_networks` is false.
example: "irc"
example: {

32
data/api/server-server/third_party_invite.yaml
View file

@ -14,7 +14,7 @@
swagger: '2.0'
info:
title: "Matrix Federation Third Party Invites API"
title: "Matrix Federation Third-party Invites API"
version: "1.0.0"
host: localhost:8448
schemes:
@ -29,7 +29,7 @@ securityDefinitions:
paths:
"/exchange_third_party_invite/{roomId}":
put:
summary: Request a server to auth a third party invite event
summary: Request a server to auth a third-party invite event
description: |-
The receiving server will verify the partial `m.room.member` event
given in the request body. If valid, the receiving server will issue
@ -42,7 +42,7 @@ paths:
- in: path
name: roomId
type: string
description: The room ID to exchange a third party invite in
description: The room ID to exchange a third-party invite in
required: true
x-example: "!abc123:matrix.org"
- in: body
@ -84,14 +84,14 @@ paths:
example: invite
third_party_invite:
type: object
description: The third party invite
title: Third Party Invite
description: The third-party invite
title: Third-party Invite
properties:
display_name:
type: string
description: |-
A name which can be displayed to represent the user instead of their
third party identifier.
third-party identifier.
example: "alice"
signed:
type: object
@ -203,11 +203,11 @@ paths:
"/3pid/onbind":
put:
summary: |-
Notifies the server that a third party identifier has been bound to one
Notifies the server that a third-party identifier has been bound to one
of its users.
description: |-
Used by identity servers to notify the homeserver that one of its users
has bound a third party identifier successfully, including any pending
has bound a third-party identifier successfully, including any pending
room invites the identity server has been made aware of.
operationId: onBindThirdPartyIdentifier
parameters:
@ -221,36 +221,36 @@ paths:
medium:
type: string
description: |-
The type of third party identifier. Currently only "email" is
The type of third-party identifier. Currently only "email" is
a possible value.
example: "email"
address:
type: string
description: |-
The third party identifier itself. For example, an email address.
The third-party identifier itself. For example, an email address.
example: "alice@example.com"
mxid:
type: string
description: The user that is now bound to the third party identifier.
description: The user that is now bound to the third-party identifier.
example: "@alice:matrix.org"
invites:
type: array
description: |-
A list of pending invites that the third party identifier has received.
A list of pending invites that the third-party identifier has received.
items:
type: object
title: Third Party Invite
title: Third-party Invite
properties:
medium:
type: string
description: |-
The type of third party invite issues. Currently only
The type of third-party invite issues. Currently only
"email" is used.
example: "email"
address:
type: string
description: |-
The third party identifier that received the invite.
The third-party identifier that received the invite.
example: "alice@example.com"
mxid:
type: string
@ -276,7 +276,7 @@ paths:
mxid:
type: string
description: |-
The user ID that has been bound to the third party
The user ID that has been bound to the third-party
identifier.
example: "@alice:matrix.org"
token:

2
data/event-schemas/schema/m.room.member.yaml
View file

@ -88,7 +88,7 @@ properties:
third_party_invite:
properties:
display_name:
description: A name which can be displayed to represent the user instead of their third party identifier
description: A name which can be displayed to represent the user instead of their third-party identifier
type: string
signed:
description: 'A block of content which has been signed, which servers can use to verify the event. Clients should ignore this.'

4
data/event-schemas/schema/m.room.third_party_invite.yaml
View file

@ -7,7 +7,7 @@ properties:
content:
properties:
display_name:
description: "A user-readable string which represents the user who has been invited. This should not contain the user's third party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third party ID."
description: "A user-readable string which represents the user who has been invited. This should not contain the user's third-party ID, as otherwise when the invite is accepted it would leak the association between the matrix ID and the third-party ID."
type: string
key_validity_url:
description: "A URL which can be fetched, with querystring public_key=public_key, to validate whether the key has been revoked. The URL must return a JSON object containing a boolean property named 'valid'."
@ -42,5 +42,5 @@ properties:
enum:
- m.room.third_party_invite
type: string
title: 'An invitation to a room issued to a third party identifier, rather than a matrix user ID.'
title: 'An invitation to a room issued to a third-party identifier, rather than a matrix user ID.'
type: object