-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
107 lines (104 loc) · 3.1 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
openapi: "3.1.0"
info:
title: Biscepter API
description: Interact with a running biscepter process for bisecting issues.
version: 1.0.0
paths:
/system:
get:
summary: Get the next running system or offending commit
responses:
"200":
description: OK
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/RunningSystem"
- $ref: "#/components/schemas/OffendingCommit"
/isGood/{systemId}:
post:
summary: Tell biscepter that this running system is good
parameters:
- in: path
name: systemId
required: true
schema:
type: string
description: The ID of the running system
responses:
"200":
description: OK
"404":
description: A running system with the given system ID was not found
/isBad/{systemId}:
post:
summary: Tell biscepter that this running system is bad
parameters:
- in: path
name: systemId
required: true
schema:
type: string
description: The ID of the running system
responses:
"200":
description: OK
"404":
description: A running system with the given system ID was not found
/stop:
post:
summary: Stop the current running job
responses:
"200":
description: OK
components:
schemas:
RunningSystem:
type: object
description: A system that is ready to be tested
properties:
systemIndex:
description: The ID of this system. Used to tell biscepter whether this system is good or bad
type: string
replicaIndex:
description: The index of the replica which produced this system
type: integer
ports:
description: A mapping of the ports specified for the system under test to the ones they were mapped to locally
type: object
additionalProperties:
type: string
required:
- systemIndex
- replicaIndex
- ports
OffendingCommit:
type: object
description: A finished bisection of a replica
properties:
replicaIndex:
description: The index of the bisected replica
type: integer
commit:
description: The commit which introduced the issue. I.e. the oldest bad commit
type: string
commitOffset:
description: The offset to the initial good commit of the commit with introduced the issue. I.e. the offset of the oldest bad commit
type: integer
commitMessage:
description: The message of the offending commit
type: string
commitDate:
description: The date of the offending commit
type: string
commitAuthor:
description: The author of the offending commit
type: string
required:
- replicaIndex
- commit
- commitOffset
- commitMessage
- commitDate
- commitAuthor