From 202bf8abb109b628a52eb4a7f3b52dcc81a05c39 Mon Sep 17 00:00:00 2001
From: Kitsune Ral <Kitsune-Ral@users.sf.net>
Date: Wed, 29 Apr 2020 20:12:51 +0200
Subject: [PATCH] Cleanup summaries and descriptions

---
 api/client-server/content-repo.yaml | 21 +++++++++++----------
 api/client-server/joining.yaml      | 17 ++++++++++-------
 2 files changed, 21 insertions(+), 17 deletions(-)

diff --git a/api/client-server/content-repo.yaml b/api/client-server/content-repo.yaml
index d596dbda3..5fd1f12d2 100644
--- a/api/client-server/content-repo.yaml
+++ b/api/client-server/content-repo.yaml
@@ -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."
diff --git a/api/client-server/joining.yaml b/api/client-server/joining.yaml
index af38d6f97..4da86022d 100644
--- a/api/client-server/joining.yaml
+++ b/api/client-server/joining.yaml
@@ -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.