Add the `deprecated` field to OpenAPI definitions and JSON Schemas (#1940)

I did a quick search of the "deprecated" word in the data folder and set the
field where the description says that a property is deprecated.

This does not change the rendering of the spec because the
descriptions already talk about the deprecation,
but it can be used by tools that rely on the OpenAPI definitions and JSON Schemas.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
pull/1867/head
Kévin Commaille 2 months ago committed by GitHub
parent 9486237f1b
commit 27b4cdcc9e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -0,0 +1 @@
Add the `deprecated` field to properties of OpenAPI definitions and JSON Schemas.

@ -139,6 +139,7 @@ paths:
type: string type: string
- in: query - in: query
name: server_name name: server_name
deprecated: true
x-changedInMatrixVersion: x-changedInMatrixVersion:
"1.12": |- "1.12": |-
This parameter has been deprecated in favour of `via` and will be removed in This parameter has been deprecated in favour of `via` and will be removed in

@ -50,6 +50,7 @@ paths:
type: string type: string
- in: query - in: query
name: server_name name: server_name
deprecated: true
x-changedInMatrixVersion: x-changedInMatrixVersion:
"1.12": |- "1.12": |-
This parameter has been deprecated in favour of `via` and will be removed in This parameter has been deprecated in favour of `via` and will be removed in

@ -119,15 +119,18 @@ paths:
$ref: definitions/user_identifier.yaml $ref: definitions/user_identifier.yaml
user: user:
type: string type: string
deprecated: true
description: The fully qualified user ID or just local part of the user ID, to description: The fully qualified user ID or just local part of the user ID, to
log in. Deprecated in favour of `identifier`. log in. Deprecated in favour of `identifier`.
medium: medium:
type: string type: string
deprecated: true
description: When logging in using a third-party identifier, the medium of the description: When logging in using a third-party identifier, the medium of the
identifier. Must be 'email'. Deprecated in favour of identifier. Must be 'email'. Deprecated in favour of
`identifier`. `identifier`.
address: address:
type: string type: string
deprecated: true
description: Third-party identifier for the user. Deprecated in favour of description: Third-party identifier for the user. Deprecated in favour of
`identifier`. `identifier`.
password: password:
@ -194,6 +197,7 @@ paths:
x-addedInMatrixVersion: "1.3" x-addedInMatrixVersion: "1.3"
home_server: home_server:
type: string type: string
deprecated: true
description: |- description: |-
The server_name of the homeserver on which the account has The server_name of the homeserver on which the account has
been registered. been registered.

@ -169,6 +169,7 @@ paths:
x-addedInMatrixVersion: "1.3" x-addedInMatrixVersion: "1.3"
home_server: home_server:
type: string type: string
deprecated: true
description: |- description: |-
The server_name of the homeserver on which the account has The server_name of the homeserver on which the account has
been registered. been registered.

@ -41,6 +41,7 @@ properties:
Olm event. For more details, see [Messaging Algorithms](/client-server-api/#messaging-algorithms). Olm event. For more details, see [Messaging Algorithms](/client-server-api/#messaging-algorithms).
sender_key: sender_key:
type: string type: string
deprecated: true
x-changedInMatrixVersion: x-changedInMatrixVersion:
"1.3": |- "1.3": |-
Previously this field was required, however given it offers no additional Previously this field was required, however given it offers no additional
@ -56,6 +57,7 @@ properties:
for more information. for more information.
device_id: device_id:
type: string type: string
deprecated: true
x-changedInMatrixVersion: x-changedInMatrixVersion:
"1.3": |- "1.3": |-
Previously this field was required for Megolm messages, however given it Previously this field was required for Megolm messages, however given it

Loading…
Cancel
Save