Apply suggestions from code review

Co-authored-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
Hubert Chathi 2020-05-05 17:02:16 -04:00 committed by GitHub
parent 30586ed98c
commit e0b4a3c912
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -31,14 +31,14 @@ paths:
post: post:
summary: Create a new backup. summary: Create a new backup.
description: |- description: |-
Creates a new backup Creates a new backup.
operationId: postRoomKeysVersion operationId: postRoomKeysVersion
security: security:
- accessToken: [] - accessToken: []
parameters: parameters:
- in: body - in: body
name: version name: version
description: "The backup configuration" description: "The backup configuration."
schema: schema:
type: object type: object
properties: properties:
@ -73,7 +73,7 @@ paths:
properties: properties:
version: version:
type: string type: string
description: The backup version description: The backup version.
example: "1" example: "1"
required: required:
- version - version
@ -146,12 +146,12 @@ paths:
- version - version
404: 404:
description: description:
The backup specified does not exist The backup specified does not exist.
examples: examples:
application/json: { application/json: {
"errcode": "M_NOT_FOUND", "errcode": "M_NOT_FOUND",
"error": "Unknown backup version" "error": "Unknown backup version"
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
tags: tags:
@ -209,12 +209,12 @@ paths:
- auth_data - auth_data
responses: responses:
200: 200:
description: The update succeeded description: The update succeeded.
schema: schema:
type: object type: object
properties: {} properties: {}
404: 404:
description: The backup specified does not exist description: The backup specified does not exist.
examples: examples:
application/json: { application/json: {
"errcode": "M_NOT_FOUND", "errcode": "M_NOT_FOUND",
@ -226,7 +226,7 @@ paths:
- End-to-end encryption - End-to-end encryption
"/room_keys/keys/{roomId}/{sessionId}": "/room_keys/keys/{roomId}/{sessionId}":
put: put:
summary: Store a key in the backup summary: Store a key in the backup.
description: |- description: |-
Store a key in the backup. Store a key in the backup.
operationId: postRoomKeysKeyRoomIdSessionId operationId: postRoomKeysKeyRoomIdSessionId
@ -254,12 +254,12 @@ paths:
x-example: "sessionid" x-example: "sessionid"
- in: body - in: body
name: data name: data
description: "The key data" description: "The key data."
schema: schema:
"$ref": "definitions/key_backup_data.yaml" "$ref": "definitions/key_backup_data.yaml"
responses: responses:
200: 200:
description: The update succeeded description: The update succeeded.
schema: schema:
type: object type: object
properties: properties: