-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
159 lines (159 loc) · 3.63 KB
/
openapi.yaml
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
openapi: '3.0.2'
info:
title: SCS Status Page API
version: '1.0'
components:
schemas:
Id:
type: string
IncidentImpactType:
type: string
IncidentPhase:
type: string
Labels:
type: object
additionalProperties:
type: string
Component:
type: object
required:
- id
- displayName
- labels
- affectedBy
properties:
id:
type: string
displayName:
type: string
labels:
$ref: '#/components/schemas/Labels'
affectedBy:
type: array
items:
$ref: '#/components/schemas/Id'
Incident:
type: object
required:
- id
- title
- affects
- impactType
- phase
properties:
id:
type: string
title:
type: string
affects:
type: array
items:
$ref: '#/components/schemas/Id'
beganAt:
type: string
format: date-time
endedAt:
type: string
format: date-time
nullable: true
impactType:
$ref: '#/components/schemas/IncidentImpactType'
phase:
$ref: '#/components/schemas/IncidentPhase'
paths:
/phases:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IncidentPhase'
/impacttypes:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IncidentImpactType'
/components/{componentId}:
get:
summary: get specific component by id
operationId: getComponent
parameters:
- in: path
name: componentId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
/components:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Component'
/incident/{incidentId}:
get:
summary: Get specific incident by id
operationId: getIncident
parameters:
- in: path
name: incidentId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Incident'
/incidents:
get:
summary: Get list of incidents
parameters:
- in: query
name: start
schema:
type: string
format: date-time
default: '2022-01-01T10:10:10.010Z'
required: true
description: Start of time frame to query for (RFC3339)
- in: query
name: end
schema:
type: string
format: date-time
default: '2024-01-01T10:10:10.010Z'
required: true
description: End of time frame to query for (RFC3339)
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Incident'