From 0f0ad5b8be2bb10ff129f4e599a8ba30714d744a Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Thu, 18 Jul 2024 09:32:21 +0200 Subject: [PATCH 1/4] Add additionalProperties in response schema of /_matrix/client/v3/profile/{userId} Signed-off-by: Johannes Marbach --- data/api/client-server/profile.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/data/api/client-server/profile.yaml b/data/api/client-server/profile.yaml index e00bdd968..249f2f616 100644 --- a/data/api/client-server/profile.yaml +++ b/data/api/client-server/profile.yaml @@ -222,6 +222,7 @@ paths: type: string description: The user's display name if they have set one, otherwise not present. + additionalProperties: true examples: response: value: { From 6402c7d7b896a7a226afbcd7251b9844c77dd624 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Thu, 18 Jul 2024 09:38:28 +0200 Subject: [PATCH 2/4] Add changelog --- changelogs/client_server/newsfragments/1910.clarification | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelogs/client_server/newsfragments/1910.clarification diff --git a/changelogs/client_server/newsfragments/1910.clarification b/changelogs/client_server/newsfragments/1910.clarification new file mode 100644 index 000000000..b297fdbde --- /dev/null +++ b/changelogs/client_server/newsfragments/1910.clarification @@ -0,0 +1 @@ +Update response schema of `GET /_matrix/client/v3/profile/{userId}` to clarify that properties other than `displayname` or `avatar_url` can be returned. From 8d3108925486267bd8fcac2758c889278e3a98b9 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 23 Jul 2024 13:29:52 +0200 Subject: [PATCH 3/4] Switch to additionalProperties: {} --- data/api/client-server/profile.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/api/client-server/profile.yaml b/data/api/client-server/profile.yaml index 249f2f616..b483af9b2 100644 --- a/data/api/client-server/profile.yaml +++ b/data/api/client-server/profile.yaml @@ -222,7 +222,7 @@ paths: type: string description: The user's display name if they have set one, otherwise not present. - additionalProperties: true + additionalProperties: {} examples: response: value: { From 186abbfb606d5b27eccd940ea9b22bf0aad101c5 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Thu, 25 Jul 2024 12:02:17 +0200 Subject: [PATCH 4/4] Remove `additionalProperties: {}` and note in description --- changelogs/client_server/newsfragments/1910.clarification | 2 +- data/api/client-server/profile.yaml | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/changelogs/client_server/newsfragments/1910.clarification b/changelogs/client_server/newsfragments/1910.clarification index b297fdbde..3664eaf68 100644 --- a/changelogs/client_server/newsfragments/1910.clarification +++ b/changelogs/client_server/newsfragments/1910.clarification @@ -1 +1 @@ -Update response schema of `GET /_matrix/client/v3/profile/{userId}` to clarify that properties other than `displayname` or `avatar_url` can be returned. +Don't mention that `GET /_matrix/client/v3/profile/{userId}` can return additional properties because this is true for almost every endpoint. diff --git a/data/api/client-server/profile.yaml b/data/api/client-server/profile.yaml index b483af9b2..1a55084c0 100644 --- a/data/api/client-server/profile.yaml +++ b/data/api/client-server/profile.yaml @@ -195,8 +195,7 @@ paths: description: |- Get the combined profile information for this user. This API may be used to fetch the user's own profile information or other users; either - locally or on remote homeservers. This API may return keys which are not - limited to `displayname` or `avatar_url`. + locally or on remote homeservers. operationId: getUserProfile parameters: - in: path @@ -222,7 +221,6 @@ paths: type: string description: The user's display name if they have set one, otherwise not present. - additionalProperties: {} examples: response: value: {