-
Notifications
You must be signed in to change notification settings - Fork 1
/
api.raml
189 lines (175 loc) · 5.41 KB
/
api.raml
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#%RAML 0.8
title: Portal API - DRAFT!!!
version: v1
mediaType: application/json
/api/
get:
description: "List of available versions"
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/versions.json
/api/{version}:
/regions:
get:
description: List of regions
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/regions.json
/regions/detailed:
get:
description: Detailed information about regions.
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/regions_detailed.json
/region/{region}:
uriParametrs:
region:
description: Region name which is region identifier
type: string
/status/{period}:
uriParametrs:
period:
description: Return data for specific period: day, week, month
type: string
get:
description: Overview of region's services status
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/status.json
404:
body:
application/json:
schema: schemas/404.json
example: !include response_examples/404/region.json
/status/health/{period}:
uriParametrs:
period:
description: Return data for specific period: day, week, month
type: string
get:
description: Region health data aggregated per service
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/status_region_health.json
404:
body:
application/json:
schema: schemas/404.json
example: !include response_examples/404/region.json
/status/availability/{period}:
uriParametrs:
period:
description: Return data for specific period: day, week, month
type: string
get:
description: Region availability data aggregated per service
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/status_region_availability.json
404:
body:
application/json:
schema: schemas/404.json
example: !include response_examples/404/region.json
/status/performance/{period}:
uriParametrs:
period:
description: Return data for specific period: day, week, month
type: string
get:
description: Region performance data aggregated per service
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/status_region_performance.json
404:
body:
application/json:
schema: schemas/404.json
example: !include response_examples/404/region.json
/infra:
get:
description: Information about region's infrastructure services
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/infra.json
404:
body:
application/json:
schema: schemas/404.json
example: !include response_examples/404/region.json
/status/{period}:
uriParametrs:
period:
description: Return data for specific period: day, week, month
type: string
get:
description: Overview data aggregated per region
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/status.json
/status/health/{period}:
uriParametrs:
period:
description: Return data for specific period: day, week, month
type: string
get:
description: Health data aggregated per region
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/status_health.json
/status/availability/{period}:
uriParametrs:
period:
description: Return data for specific period: day, week, month
type: string
get:
description: Availability data aggregated per region
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/status_availability.json
/status/performance/{period}:
uriParametrs:
period:
description: Return data for specific period: day, week, month
type: string
get:
description: Performance data aggregated per region
responses:
200:
body:
application/json:
schema: schemas/200.json
example: !include response_examples/200/status_performance.json