Skip to content

Commit 6aedd61

Browse files
committed
added descriptions to filter fields (https://app.clickup.com/t/4535044/SP-15297)
1 parent b865985 commit 6aedd61

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

search.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,24 @@ definitions:
6464

6565
FilterSearchRequest:
6666
type: object
67+
description: "Allows to filter the search results based on the Person's `name`."
6768
properties:
6869
op:
6970
$ref: '#/definitions/FilterOpEnum'
7071
field:
7172
type: string
73+
description: "`name` of the Person."
7274
value:
7375
type: array
76+
description: "The list of `name` values against which the `field` is compared."
7477
items:
7578
type: string
7679

7780
FilterOpEnum:
7881
type: string
82+
description: "The filter condition, determines the type of comparison to be performed on the `name` values of the Person entity. <br><br>When set to `in`,
83+
the `name` values of the Person should match any of the values specified in the `value` list. <br><br>When set to `nin`,
84+
the `name` values of the Person should not match any of the values specified in the `value` list."
7985
enum:
8086
- "in"
8187
- "nin"

0 commit comments

Comments
 (0)