Skip to content

Commit f837e42

Browse files
committed
Some cleanup plus documentation improvements
1 parent 6776728 commit f837e42

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

test-monitor/nitestmonitor.yml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -637,11 +637,16 @@ definitions:
637637
type: object
638638
properties:
639639
filter:
640-
description: Query filter, in Dynamic Linq
640+
description: The query filter, in Dynamic Linq
641641
type: string
642642
example: (operator == "user1") || ((programName != "MyProgram") && (totalTimeInSeconds < @0))
643643
substitutions:
644-
description: Substitutions to make into the filter expression
644+
description: >-
645+
Substitutions to make into the query filter expression. Substitutions in the query expression
646+
are indicated by a non-negative integer prefixed with the "@" symbol, such as "@3." Each
647+
substitution in the given expression will be replaced by the element at the corresponding
648+
index (zero-based) in this list. For example, "@0" in the filter expression will be replaced with
649+
the element at the zeroth index of the substitutions list.
645650
type: array
646651
items:
647652
type: object
@@ -1202,7 +1207,7 @@ paths:
12021207
/v2/query-results:
12031208
post:
12041209
tags: [results]
1205-
summary: Queries test results using a query language
1210+
summary: Advanced Test Result Query
12061211
description: Uses the Dynamic Linq query language to specify a filter and return test results. An empty request body queries all test results.
12071212
operationId: query-results-v2
12081213
x-ni-operation: queryResults
@@ -1435,8 +1440,8 @@ paths:
14351440
/v2/query-steps:
14361441
post:
14371442
tags: [steps]
1438-
summary: Queries test steps using a query language
1439-
description: Uses the Dynamic Linq query language to specify a filter and return test results. An empty request body queries all test results.
1443+
summary: Advanced Test Step Query
1444+
description: Uses the Dynamic Linq query language to specify a filter and return test steps. An empty request body queries all test steps.
14401445
operationId: query-steps-v2
14411446
x-ni-operation: querySteps
14421447
x-ni-privilege: Read

0 commit comments

Comments
 (0)