Merge pull request #3330 from lukaslihotzki/add-titles

OpenAPI: add titles

Author: KitsuneRal

changelogs/client_server/newsfragments/3330.clarification

@@ -0,0 +1 @@
+Add titles for OpenAPI objects.

data/api/client-server/definitions/errors/error.yaml

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 type: object
+title: Error
 description: A Matrix-level Error
 properties:
   errcode:
@@ -22,4 +23,4 @@ properties:
     type: string
     description: A human-readable error message.
     example: An unknown error occurred
-required: ["errcode"]
+required: ["errcode"]

data/api/client-server/definitions/errors/rate_limited.yaml

@@ -13,6 +13,7 @@
 # limitations under the License.
 $ref: error.yaml
 type: object
+title: RateLimitError
 description: The rate limit was reached for this request
 properties:
   errcode:
@@ -29,4 +30,4 @@ properties:
       The amount of time in milliseconds the client should wait
       before trying the request again.
     example: 2000
-required: ["errcode"]
+required: ["errcode"]

data/api/client-server/definitions/event_batch.yaml

@@ -21,3 +21,4 @@ properties:
       type: object
     type: array
 type: object
+title: EventBatch

data/api/client-server/definitions/openid_token.yaml

@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 type: object
+title: OpenIdCredentials
 properties:
   access_token:
     type: string

data/api/client-server/definitions/request_token_response.yaml

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 type: object
+title: RequestTokenResponse
 properties:
   sid:
     type: string

data/api/client-server/definitions/room_event_batch.yaml

@@ -25,3 +25,4 @@ properties:
       - origin_server_ts
     type: array
 type: object
+title: RoomEventBatch

data/api/client-server/definitions/state_event_batch.yaml

@@ -26,3 +26,4 @@ properties:
       - state_key
     type: array
 type: object
+title: StateEventBatch

data/api/client-server/definitions/timeline_batch.yaml

@@ -24,3 +24,4 @@ properties:
       rooms/{roomId}/messages endpoint.
     type: string
 type: object
+title: TimelineBatch

data/api/client-server/key_backup.yaml

@@ -409,6 +409,7 @@ paths:
           description: The update succeeded.
           schema:
             type: object
+            title: RoomKeysUpdateResponse
             properties:
               etag:
                 description: |-
@@ -521,6 +522,7 @@ paths:
           description: The update succeeded
           schema:
             type: object
+            title: RoomKeysUpdateResponse
             properties:
               etag:
                 description: |-
@@ -584,6 +586,7 @@ paths:
           description: The update succeeded
           schema:
             type: object
+            title: RoomKeysUpdateResponse
             properties:
               etag:
                 description: |-
@@ -698,6 +701,7 @@ paths:
           description: The update succeeded
           schema:
             type: object
+            title: RoomKeysUpdateResponse
             properties:
               etag:
                 description: |-
@@ -781,6 +785,7 @@ paths:
           description: The update succeeded
           schema:
             type: object
+            title: RoomKeysUpdateResponse
             properties:
               etag:
                 description: |-
@@ -905,6 +910,7 @@ paths:
           description: The update succeeded
           schema:
             type: object
+            title: RoomKeysUpdateResponse
             properties:
               etag:
                 description: |-