Updating API docs #6434 to better describe the API for range and for oneOf operator.
This commit is contained in:
parent
9b41a2a438
commit
9a7c1e714b
|
@ -150,6 +150,11 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read))
|
||||||
* query:
|
* query:
|
||||||
* type: object
|
* type: object
|
||||||
* properties:
|
* 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:
|
* string:
|
||||||
* type: object
|
* type: object
|
||||||
* example:
|
* example:
|
||||||
|
@ -167,9 +172,9 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read))
|
||||||
* range:
|
* range:
|
||||||
* type: object
|
* type: object
|
||||||
* description: Searches within a range, the format of this must be
|
* description: Searches within a range, the format of this must be
|
||||||
* columnName -> [low, high].
|
* columnName -> { low: value1, high: value2 }.
|
||||||
* example:
|
* example:
|
||||||
* columnName1: [10, 20]
|
* columnName1: { low: 10, high: 20 }
|
||||||
* equal:
|
* equal:
|
||||||
* type: object
|
* type: object
|
||||||
* description: Searches for rows that have a column value that is
|
* 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
|
* type: object
|
||||||
* description: Searches for rows which have a column value that is any
|
* 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].
|
* of the specified values. The format of this must be columnName -> [value1, value2].
|
||||||
|
* Note this is only supported for SQL based tables.
|
||||||
* paginate:
|
* paginate:
|
||||||
* type: boolean
|
* type: boolean
|
||||||
* description: Enables pagination, by default this is disabled.
|
* description: Enables pagination, by default this is disabled.
|
||||||
|
|
Loading…
Reference in New Issue