Skip to content

Commit fd469c6

Browse files
committed
Add descriptions for skip/take and ensure default and minimum values are correct
1 parent 283f7b2 commit fd469c6

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

test-monitor/nitestmonitor.yml

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1187,16 +1187,26 @@ paths:
11871187
$ref: '#/definitions/AdvancedQuery'
11881188
- in: query
11891189
name: skip
1190+
description: >-
1191+
The number of results to skip when paging.
1192+
For example, if the query filter matches 100 results with a skip
1193+
value of 50 and a take value of 25, results 51 through 75 will be
1194+
returned.
11901195
type: integer
11911196
format: int32
11921197
default: 0
11931198
minimum: 0
11941199
- in: query
11951200
name: take
1201+
description: >-
1202+
The total number of results to return.
1203+
For example, if the query filter matches 100 results with a skip
1204+
value of 50 and a take value of 25, results 51 through 75 will be
1205+
returned.
11961206
type: integer
11971207
format: int32
1198-
default: -1
1199-
minimum: -1
1208+
default: 1000
1209+
minimum: 0
12001210
responses:
12011211
200:
12021212
$ref: '#/responses/ResultsQueryResponse'
@@ -1386,16 +1396,26 @@ paths:
13861396
$ref: '#/definitions/AdvancedQuery'
13871397
- in: query
13881398
name: skip
1399+
description: >-
1400+
The number of steps to skip when paging.
1401+
For example, if the query filter matches 100 steps with a skip
1402+
value of 50 and a take value of 25, steps 51 through 75 will be
1403+
returned.
13891404
type: integer
13901405
format: int32
13911406
default: 0
13921407
minimum: 0
13931408
- in: query
13941409
name: take
1410+
description: >-
1411+
The total number of steps to return.
1412+
For example, if the query filter matches 100 steps with a skip
1413+
value of 50 and a take value of 25, steps 51 through 75 will be
1414+
returned.
13951415
type: integer
13961416
format: int32
1397-
default: -1
1398-
minimum: -1
1417+
default: 1000
1418+
minimum: 0
13991419
responses:
14001420
200:
14011421
$ref: '#/responses/StepsQueryResponse'

0 commit comments

Comments
 (0)