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

Cleanup summaries and descriptions

Browse source
This commit is contained in:
Kitsune Ral 2020-04-29 20:12:51 +02:00
parent c441e74b27
commit 202bf8abb1
2 changed files with 21 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

21
api/client-server/content-repo.yaml
View file

@ -163,9 +163,10 @@ paths:
- Media
"/download/{serverName}/{mediaId}/{fileName}":
get:
summary: |-
Download content from the content repository. This is the same as
the download endpoint above, except permitting a desired file name.
summary: Download content from the content repository overriding the file name
description: |-
This is the same as the download endpoint above, except permitting
a desired file name.
operationId: getContentOverrideName
produces: ["*/*"]
parameters:
@ -233,9 +234,9 @@ paths:
- Media
"/thumbnail/{serverName}/{mediaId}":
get:
summary: |-
Download a thumbnail of content from the content repository. See the `thumbnailing <#thumbnails>`_
section for more information.
summary: Download a thumbnail of content from the content repository
description: |-
See the `thumbnailing <#thumbnails>`_ section for more information.
operationId: getContentThumbnail
produces: ["image/jpeg", "image/png"]
parameters:
@ -283,10 +284,10 @@ paths:
x-example: false
required: false
default: true
description: |
Indicates to the server that it should not attempt to fetch the media if it is deemed
remote. This is to prevent routing loops where the server contacts itself. Defaults to
true if not provided.
description: |-
Indicates to the server that it should not attempt to fetch
the media if it is deemed remote. This is to prevent routing loops
where the server contacts itself. Defaults to true if not provided.
responses:
200:
description: "A thumbnail of the requested content."

17
api/client-server/joining.yaml
View file

@ -31,7 +31,8 @@ paths:
post:
summary: Start the requesting user participating in a particular room.
description: |-
*Note that this API requires a room ID, not alias.* ``/join/{roomIdOrAlias}`` *exists if you have a room alias.*
*Note that this API requires a room ID, not alias.*
``/join/{roomIdOrAlias}`` *exists if you have a room alias.*
This API starts a user participating in a particular room, if that user
is allowed to participate in that room. After this call, the client is
@ -40,10 +41,6 @@ paths:
After a user has joined a room, the room will appear as an entry in the
response of the |/initialSync|_ and |/sync|_ APIs.
If a ``third_party_signed`` was supplied, the homeserver must verify
that it matches a pending ``m.room.third_party_invite`` event in the
room, and perform key validity checking if required by the event.
operationId: joinRoomById
security:
- accessToken: []
@ -56,6 +53,10 @@ paths:
x-example: "!d41d8cd:matrix.org"
- in: body
name: third_party_signed
description: |-
If supplied, the homeserver must verify that it matches a pending
``m.room.third_party_invite`` event in the room, and perform
key validity checking if required by the event.
schema:
type: object
properties:
@ -79,7 +80,8 @@ paths:
required: ["room_id"]
403:
description: |-
You do not have permission to join the room. A meaningful ``errcode`` and description error text will be returned. Example reasons for rejection are:
You do not have permission to join the room. A meaningful ``errcode``
and description error text will be returned. Example reasons for rejection are:
- The room is invite-only and the user was not invited.
- The user has been banned from the room.
@ -155,7 +157,8 @@ paths:
required: ["room_id"]
403:
description: |-
You do not have permission to join the room. A meaningful ``errcode`` and description error text will be returned. Example reasons for rejection are:
You do not have permission to join the room. A meaningful ``errcode``
and description error text will be returned. Example reasons for rejection are:
- The room is invite-only and the user was not invited.
- The user has been banned from the room.