Skip to content

Commit fb9b8fc

Browse files
dkolpakovqasedkolpakovqase
authored
Merge pull request #164 from qase-tms/PP-1371
PP-1371 Updated the QQL response schema
2 parents b4aad48 + dce3a1f commit fb9b8fc

File tree

10 files changed

+221
-4
lines changed

10 files changed

+221
-4
lines changed

‎testops-api/v1/schemas/Requirement.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ properties:
33
id:
44
type: integer
55
format: int64
6+
requirement_id:
7+
type: integer
8+
format: int64
69
parent_id:
710
type: integer
811
format: int64

‎testops-api/v1/schemas/Result.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ type: object
22
properties:
33
hash:
44
type: string
5+
result_hash:
6+
type: string
57
comment:
68
type: string
79
nullable: true

‎testops-api/v1/schemas/Run.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ properties:
33
id:
44
type: integer
55
format: int64
6+
run_id:
7+
type: integer
8+
format: int64
69
title:
710
type: string
811
description:

‎testops-api/v1/schemas/qql/DefectQuery.yaml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ properties:
33
id:
44
type: integer
55
format: int64
6+
defect_id:
7+
type: integer
8+
format: int64
69
title:
710
type: string
811
actual_result:
@@ -48,4 +51,6 @@ properties:
4851
updated_at:
4952
type: string
5053
format: date-time
51-
example: "2021-12-30T19:23:59+00:00"
54+
example: "2021-12-30T19:23:59+00:00"
55+
required:
56+
- defect_id

‎testops-api/v1/schemas/qql/PlanQuery.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ properties:
33
id:
44
type: integer
55
format: int64
6+
plan_id:
7+
type: integer
8+
format: int64
69
title:
710
type: string
811
description:
@@ -18,3 +21,5 @@ properties:
1821
type: string
1922
format: date-time
2023
example: "2021-12-30T19:23:59+00:00"
24+
required:
25+
- plan_id

‎testops-api/v1/schemas/qql/RequirementQuery.yaml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
type: object
2+
properties:
3+
id:
4+
type: integer
5+
format: int64
6+
requirement_id:
7+
type: integer
8+
format: int64
9+
parent_id:
10+
type: integer
11+
format: int64
12+
nullable: true
13+
member_id:
14+
type: integer
15+
format: int64
16+
title:
17+
type: string
18+
description:
19+
type: string
20+
nullable: true
21+
status:
22+
type: string
23+
enum:
24+
- valid
25+
- draft
26+
- review
27+
- rework
28+
- finish
29+
- implemented
30+
- not-testable
31+
- obsolete
32+
type:
33+
type: string
34+
enum:
35+
- epic
36+
- user-story
37+
- feature
38+
created_at:
39+
type: string
40+
format: date-time
41+
example: "2021-12-30T19:23:59+00:00"
42+
updated_at:
43+
type: string
44+
format: date-time
45+
example: "2021-12-30T19:23:59+00:00"
46+
nullable: true
47+
required:
48+
- requirement_id

‎testops-api/v1/schemas/qql/ResultQuery.yaml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
type: object
2+
properties:
3+
hash:
4+
type: string
5+
result_hash:
6+
type: string
7+
comment:
8+
type: string
9+
nullable: true
10+
stacktrace:
11+
type: string
12+
nullable: true
13+
run_id:
14+
type: integer
15+
format: int64
16+
case_id:
17+
type: integer
18+
format: int64
19+
steps:
20+
type: array
21+
nullable: true
22+
items:
23+
$ref: '../TestStepResult.yaml'
24+
status:
25+
type: string
26+
is_api_result:
27+
type: boolean
28+
time_spent_ms:
29+
type: integer
30+
format: int64
31+
end_time:
32+
type: string
33+
format: date-time
34+
example: "2021-12-30T19:23:59+00:00"
35+
nullable: true
36+
attachments:
37+
type: array
38+
items:
39+
$ref: '../Attachment.yaml'
40+
required:
41+
- result_hash

‎testops-api/v1/schemas/qql/RunQuery.yaml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
type: object
2+
properties:
3+
id:
4+
type: integer
5+
format: int64
6+
run_id:
7+
type: integer
8+
format: int64
9+
title:
10+
type: string
11+
description:
12+
type: string
13+
nullable: true
14+
status:
15+
type: integer
16+
status_text:
17+
type: string
18+
start_time:
19+
type: string
20+
format: date-time
21+
example: "2021-12-30T19:23:59+00:00"
22+
nullable: true
23+
end_time:
24+
type: string
25+
format: date-time
26+
example: "2021-12-30T19:23:59+00:00"
27+
nullable: true
28+
public:
29+
type: boolean
30+
stats:
31+
type: object
32+
properties:
33+
total:
34+
type: integer
35+
statuses:
36+
type: object
37+
additionalProperties:
38+
type: integer
39+
untested:
40+
type: integer
41+
deprecated: true
42+
passed:
43+
type: integer
44+
deprecated: true
45+
failed:
46+
type: integer
47+
deprecated: true
48+
blocked:
49+
type: integer
50+
deprecated: true
51+
skipped:
52+
type: integer
53+
deprecated: true
54+
retest:
55+
type: integer
56+
deprecated: true
57+
in_progress:
58+
type: integer
59+
deprecated: true
60+
invalid:
61+
type: integer
62+
deprecated: true
63+
time_spent:
64+
type: integer
65+
format: int64
66+
description: Time in ms.
67+
environment:
68+
type: object
69+
properties:
70+
title:
71+
type: string
72+
description:
73+
type: string
74+
slug:
75+
type: string
76+
host:
77+
type: string
78+
nullable: true
79+
milestone:
80+
type: object
81+
properties:
82+
title:
83+
type: string
84+
description:
85+
type: string
86+
nullable: true
87+
custom_fields:
88+
type: array
89+
items:
90+
$ref: './../CustomFieldValue.yaml'
91+
tags:
92+
type: array
93+
items:
94+
$ref: './../Tag.value.yaml'
95+
cases:
96+
type: array
97+
items:
98+
type: integer
99+
format: int64
100+
plan_id:
101+
type: integer
102+
format: int64
103+
nullable: true
104+
required:
105+
- run_id

‎testops-api/v1/schemas/qql/TestCaseQuery.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ properties:
33
id:
44
type: integer
55
format: int64
6+
test_case_id:
7+
type: integer
8+
format: int64
69
position:
710
type: integer
811
title:
@@ -80,3 +83,5 @@ properties:
8083
type: string
8184
format: date-time
8285
example: "2021-12-30T19:23:59+00:00"
86+
required:
87+
- test_case_id

‎testops-api/v1/schemas/responses/SearchResponse.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ allOf:
99
type: array
1010
items:
1111
oneOf:
12-
- $ref: '../Run.yaml'
13-
- $ref: '../Result.yaml'
14-
- $ref: '../Requirement.yaml'
12+
- $ref: '../qql/RunQuery.yaml'
13+
- $ref: '../qql/ResultQuery.yaml'
14+
- $ref: '../qql/RequirementQuery.yaml'
1515
- $ref: '../qql/TestCaseQuery.yaml'
1616
- $ref: '../qql/DefectQuery.yaml'
1717
- $ref: '../qql/PlanQuery.yaml'

0 commit comments

Comments
 (0)