Skip to content

Commit 6776728

Browse files
committed
Initial post of API changes
1 parent a7f2d80 commit 6776728

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

test-monitor/nitestmonitor.yml

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -632,6 +632,21 @@ definitions:
632632
type: array
633633
items:
634634
$ref: '#/definitions/ResultSortDefinitionObject'
635+
AdvancedQuery:
636+
title: Advanced Query Object for Test Data
637+
type: object
638+
properties:
639+
filter:
640+
description: Query filter, in Dynamic Linq
641+
type: string
642+
example: (operator == "user1") || ((programName != "MyProgram") && (totalTimeInSeconds < @0))
643+
substitutions:
644+
description: Substitutions to make into the filter expression
645+
type: array
646+
items:
647+
type: object
648+
example:
649+
- 2.5
635650
StepIdResultIdPair:
636651
title: Step Id / Result Id Pair
637652
type: object
@@ -1184,6 +1199,40 @@ paths:
11841199
$ref: '#/responses/Unauthorized'
11851200
default:
11861201
$ref: '#/responses/Error'
1202+
/v2/query-results:
1203+
post:
1204+
tags: [results]
1205+
summary: Queries test results using a query language
1206+
description: Uses the Dynamic Linq query language to specify a filter and return test results. An empty request body queries all test results.
1207+
operationId: query-results-v2
1208+
x-ni-operation: queryResults
1209+
x-ni-privilege: Read
1210+
parameters:
1211+
- in: body
1212+
name: postBody
1213+
description: Query filter
1214+
required: false
1215+
schema:
1216+
$ref: '#/definitions/AdvancedQuery'
1217+
- in: query
1218+
name: skip
1219+
type: integer
1220+
format: int32
1221+
default: 0
1222+
minimum: 0
1223+
- in: query
1224+
name: take
1225+
type: integer
1226+
format: int32
1227+
default: -1
1228+
minimum: -1
1229+
responses:
1230+
200:
1231+
$ref: '#/responses/ResultsQueryResponse'
1232+
401:
1233+
$ref: '#/responses/Unauthorized'
1234+
default:
1235+
$ref: '#/responses/Error'
11871236
/v1/results:
11881237
get:
11891238
tags: [results]
@@ -1383,6 +1432,40 @@ paths:
13831432
$ref: '#/responses/Unauthorized'
13841433
default:
13851434
$ref: '#/responses/Error'
1435+
/v2/query-steps:
1436+
post:
1437+
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.
1440+
operationId: query-steps-v2
1441+
x-ni-operation: querySteps
1442+
x-ni-privilege: Read
1443+
parameters:
1444+
- in: body
1445+
name: postBody
1446+
description: Query filter
1447+
required: false
1448+
schema:
1449+
$ref: '#/definitions/AdvancedQuery'
1450+
- in: query
1451+
name: skip
1452+
type: integer
1453+
format: int32
1454+
default: 0
1455+
minimum: 0
1456+
- in: query
1457+
name: take
1458+
type: integer
1459+
format: int32
1460+
default: -1
1461+
minimum: -1
1462+
responses:
1463+
200:
1464+
$ref: '#/responses/StepsQueryResponse'
1465+
401:
1466+
$ref: '#/responses/Unauthorized'
1467+
default:
1468+
$ref: '#/responses/Error'
13861469
/v1/steps:
13871470
get:
13881471
tags: [steps]

0 commit comments

Comments
 (0)