Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Oct 1, 2024
+10 −0
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7d3a73
Add the deprecated field to OpenAPI definitions and JSON Schemas
zecakeh Sep 4, 2024
ef10833
Add changelog
zecakeh Sep 4, 2024
3f5493f
Fix changelog
zecakeh Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/internal/newsfragments/1940.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add the `deprecated` field to properties of OpenAPI definitions and JSON Schemas.
1 change: 1 addition & 0 deletions data/api/client-server/joining.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ paths:
type: string
- in: query
name: server_name
deprecated: true
x-changedInMatrixVersion:
"1.12": |-
This parameter has been deprecated in favour of `via` and will be removed in
Expand Down
1 change: 1 addition & 0 deletions data/api/client-server/knocking.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ paths:
type: string
- in: query
name: server_name
deprecated: true
x-changedInMatrixVersion:
"1.12": |-
This parameter has been deprecated in favour of `via` and will be removed in
Expand Down
4 changes: 4 additions & 0 deletions data/api/client-server/login.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,15 +119,18 @@ paths:
$ref: definitions/user_identifier.yaml
user:
type: string
deprecated: true
description: The fully qualified user ID or just local part of the user ID, to
log in. Deprecated in favour of `identifier`.
medium:
type: string
deprecated: true
description: When logging in using a third-party identifier, the medium of the
identifier. Must be 'email'. Deprecated in favour of
`identifier`.
address:
type: string
deprecated: true
description: Third-party identifier for the user. Deprecated in favour of
`identifier`.
password:
Expand Down Expand Up @@ -194,6 +197,7 @@ paths:
x-addedInMatrixVersion: "1.3"
home_server:
type: string
deprecated: true
description: |-
The server_name of the homeserver on which the account has
been registered.
Expand Down
1 change: 1 addition & 0 deletions data/api/client-server/registration.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ paths:
x-addedInMatrixVersion: "1.3"
home_server:
type: string
deprecated: true
description: |-
The server_name of the homeserver on which the account has
been registered.
Expand Down
2 changes: 2 additions & 0 deletions data/event-schemas/schema/m.room.encrypted.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ properties:
Olm event. For more details, see [Messaging Algorithms](/client-server-api/#messaging-algorithms).
sender_key:
type: string
deprecated: true
x-changedInMatrixVersion:
"1.3": |-
Previously this field was required, however given it offers no additional
Expand All @@ -56,6 +57,7 @@ properties:
for more information.
device_id:
type: string
deprecated: true
x-changedInMatrixVersion:
"1.3": |-
Previously this field was required for Megolm messages, however given it
Expand Down