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

Use example.org on examples instead of domain.com which is a real domain

Browse source 
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
This commit is contained in:
Konstantinos Sideris 2018-09-02 17:58:21 +03:00
parent 9e82b18e24
commit 192a6c2ab9
37 changed files with 91 additions and 91 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api/client-server/administrative_contact.yaml
View file

@ -171,7 +171,7 @@ paths:
address:
type: string
description: The third party address being removed.
example: "example@domain.com"
example: "example@example.org"
required: ['medium', 'address']
responses:
200:

2
api/client-server/appservice_room_directory.yaml
View file

@ -59,7 +59,7 @@ paths:
name: roomId
description: The room ID to add to the directory.
required: true
x-example: "!somewhere:domain.com"
x-example: "!somewhere:example.org"
- in: body
name: body
required: true

8
api/client-server/read_markers.yaml
View file

@ -42,7 +42,7 @@ paths:
name: roomId
description: The room ID to set the read marker in for the user.
required: true
x-example: "!somewhere:domain.com"
x-example: "!somewhere:example.org"
- in: body
name: body
description: The read marker and optional read receipt locations.
@ -55,14 +55,14 @@ paths:
description: |-
The event ID the read marker should be located at. The
event MUST belong to the room.
example: "$somewhere:domain.com"
example: "$somewhere:example.org"
"m.read":
type: string
description: |-
The event ID to set the read receipt location at. This is
equivalent to calling ``/receipt/m.read/$elsewhere:domain.com``
equivalent to calling ``/receipt/m.read/$elsewhere:example.org``
and is provided here to save that extra call.
example: "$elsewhere:domain.com"
example: "$elsewhere:example.org"
required: ['m.fully_read']
responses:
200:

2
api/client-server/report_content.yaml
View file

@ -46,7 +46,7 @@ paths:
name: eventId
description: The event to report.
required: true
x-example: "$something:domain.com"
x-example: "$something:example.org"
- in: body
name: body
schema:

10
api/server-server/backfill.yaml
View file

@ -20,7 +20,7 @@ host: localhost:8448
schemes:
- https
basePath: /_matrix/federation/v1
consumes:
consumes:
- application/json
produces:
- application/json
@ -49,7 +49,7 @@ paths:
type: array
items:
type: string
description: The event IDs to backfill from.
description: The event IDs to backfill from.
required: true
x-example: ["$abc123:matrix.org"]
- in: query
@ -118,18 +118,18 @@ paths:
the previous events of ``latest_events``.
items:
type: string
example: ["$missing_event:domain.com"]
example: ["$missing_event:example.org"]
latest_events:
type: array
description: The events to retrieve the previous events for.
items:
type: string
example: ["$event_that_has_the_missing_event_as_a_previous_event:domain.com"]
example: ["$event_that_has_the_missing_event_as_a_previous_event:example.org"]
required: ['earliest_events', 'latest_events']
responses:
200:
description: |-
The previous events for ``latest_events``, excluding any ``earliest_events``, up to the
The previous events for ``latest_events``, excluding any ``earliest_events``, up to the
provided ``limit``.
schema:
type: object

4
api/server-server/definitions/event-schemas/m.presence_deny.yaml
View file

@ -18,12 +18,12 @@ description: |-
An EDU representing a declination or revocation for the observing user
to subscribe to the presence of the observed user.
example: {
"origin": "domain.com",
"origin": "example.org",
"destination": "elsewhere.org",
"edu_type": "m.presence_deny",
"content": {
"observed_user": "@alice:elsewhere.org",
"observer_user": "@john:domain.com"
"observer_user": "@john:example.org"
}
}
allOf:

2
api/server-server/definitions/event-schemas/m.receipt.yaml
View file

@ -69,7 +69,7 @@ allOf:
required: ['event_ids', 'data']
required: ['m.read']
example: {
"!some_room:domain.com": {
"!some_room:example.org": {
"m.read": {
"@john:matrix.org": {
"event_ids": ["$read_this_event:matrix.org"],

4
api/server-server/definitions/unsigned_pdu.yaml
View file

@ -126,11 +126,11 @@ properties:
replaces_state:
type: string
description: The event ID of the state event this event replaces.
example: "$state_event:domain.com"
example: "$state_event:example.org"
prev_sender:
type: string
description: The sender of the replaced state event.
example: "@someone:domain.com"
example: "@someone:example.org"
prev_content:
type: object
description: The content of the replaced state event.

10
api/server-server/event_auth.yaml
View file

@ -47,7 +47,7 @@ paths:
type: string
description: The event ID to get the auth chain of.
required: true
x-example: "$helloworld:domain.com"
x-example: "$helloworld:example.org"
responses:
200:
description: The auth chain for the event.
@ -90,7 +90,7 @@ paths:
type: string
description: The event ID to compare the auth chain of.
required: true
x-example: "$helloworld:domain.com"
x-example: "$helloworld:example.org"
- in: body
name: body
schema:
@ -127,7 +127,7 @@ paths:
The reason for the event being rejected.
required: ['reason']
example: {
"$some_event:domain.com": {
"$some_event:example.org": {
"reason": "auth_error"
}
}
@ -153,7 +153,7 @@ paths:
after comparing the "remote auth" and "local auth" chains.
items:
type: string
example: ["$a_missing_event:domain.com"]
example: ["$a_missing_event:example.org"]
rejects:
type: object
description: |-
@ -173,7 +173,7 @@ paths:
The reason for the event being rejected.
required: ['reason']
example: {
"$some_event:domain.com": {
"$some_event:example.org": {
"reason": "auth_error"
}
}

4
api/server-server/events.yaml
View file

@ -110,14 +110,14 @@ paths:
of the room, and their authorization events, recursively.
items:
type: string
example: ["$an_event:domain.com"]
example: ["$an_event:example.org"]
pdu_ids:
type: array
description: |-
The fully resolved state of the room at the given event.
items:
type: string
example: ["$an_event:domain.com"]
example: ["$an_event:example.org"]
required: ['auth_chain_ids', 'pdu_ids']
"/event/{eventId}":
get:

4
api/server-server/third_party_invite.yaml
View file

@ -222,7 +222,7 @@ paths:
type: string
description: |-
The third party identifier itself. For example, an email address.
example: "alice@domain.com"
example: "alice@example.com"
mxid:
type: string
description: The user that is now bound to the third party identifier.
@ -245,7 +245,7 @@ paths:
type: string
description: |-
The third party identifier that received the invite.
example: "alice@domain.com"
example: "alice@example.com"
mxid:
type: string
description: The now-bound user ID that received the invite.

2
api/server-server/transactions.yaml
View file

@ -107,7 +107,7 @@ paths:
200,
{
"pdus": {
"$successful_event:domain.com": {},
"$successful_event:example.org": {},
"$failed_event:example.org": {
"error": "You are not allowed to send a message to this room."
}