From 9d07c9a014b89f6ee4add241ac3be2b0656106c6 Mon Sep 17 00:00:00 2001 From: TheOneWithTheBraid Date: Mon, 30 May 2022 07:11:36 +0200 Subject: [PATCH] fix: spaces hierarchy paramater types - changed `limit` parameter type to integer - changed `query` parameter type to integer A floating number does not make any sense here. Also, at least Synapse does not allow floating point numbers in here. Signed-off-by: TheOneWithTheBraid --- changelogs/client_server/newsfragments/1097.clarification | 1 + data/api/client-server/space_hierarchy.yaml | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 changelogs/client_server/newsfragments/1097.clarification diff --git a/changelogs/client_server/newsfragments/1097.clarification b/changelogs/client_server/newsfragments/1097.clarification new file mode 100644 index 00000000..3fb60041 --- /dev/null +++ b/changelogs/client_server/newsfragments/1097.clarification @@ -0,0 +1 @@ +Adjust the data types of the Spaces Hierarchy query parameters. diff --git a/data/api/client-server/space_hierarchy.yaml b/data/api/client-server/space_hierarchy.yaml index 607eb8d1..12640b53 100644 --- a/data/api/client-server/space_hierarchy.yaml +++ b/data/api/client-server/space_hierarchy.yaml @@ -58,7 +58,7 @@ paths: contents. x-example: true - in: query - type: number + type: integer name: limit description: |- Optional limit for the maximum number of rooms to include per response. Must be an integer @@ -67,7 +67,7 @@ paths: Servers should apply a default value, and impose a maximum value to avoid resource exhaustion. x-example: 20 - in: query - type: number + type: integer name: max_depth description: |- Optional limit for how far to go into the space. Must be a non-negative integer.