From f283417b6d871549fd165944437a3736a0dfcad5 Mon Sep 17 00:00:00 2001 From: mike12345567 Date: Tue, 5 Jul 2022 18:47:30 +0100 Subject: [PATCH] Updating API docs #6434 to better describe the API for range and for oneOf operator. --- packages/server/src/api/routes/public/rows.ts | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/packages/server/src/api/routes/public/rows.ts b/packages/server/src/api/routes/public/rows.ts index 8428773dff..cdb954717d 100644 --- a/packages/server/src/api/routes/public/rows.ts +++ b/packages/server/src/api/routes/public/rows.ts @@ -150,6 +150,11 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read)) * query: * type: object * properties: + * allOr: + * type: boolean + * description: Specifies that a row should be returned if it satisfies + * any of the specified options, rather than requiring it to fulfill all + * the search parameters. This defaults to false, meaning AND logic will be used. * string: * type: object * example: @@ -167,9 +172,9 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read)) * range: * type: object * description: Searches within a range, the format of this must be - * columnName -> [low, high]. + * columnName -> { low: value1, high: value2 }. * example: - * columnName1: [10, 20] + * columnName1: { low: 10, high: 20 } * equal: * type: object * description: Searches for rows that have a column value that is @@ -192,6 +197,7 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read)) * type: object * description: Searches for rows which have a column value that is any * of the specified values. The format of this must be columnName -> [value1, value2]. + * Note this is only supported for SQL based tables. * paginate: * type: boolean * description: Enables pagination, by default this is disabled.