-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
258 lines (258 loc) · 6.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
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
openapi: "3.0.3"
info:
version: 2.0.0
title: Nixie
description: A service that allows to create, update and delete counters.
contact:
name: Eric Avdey
url: https://github.com/eiri
license:
name: MIT
url: https://github.com/eiri/nixie-prototype/blob/main/LICENSE
paths:
/:
get:
tags:
- root
summary: List all counters' keys.
responses:
200:
description: A list of counter keys
content:
text/plain:
schema:
$ref: "#/components/schemas/Keys"
500:
$ref: "#/components/responses/500"
post:
tags:
- root
summary: Create a new coutner.
requestBody:
description: An initial value for a specific counter.
required: false
content:
text/plain:
schema:
$ref: "#/components/schemas/Counter"
parameters:
- name: Nixie-Name
in: header
required: true
description: A human friendly name of the counter.
schema:
type: string
example: "new-response-ok"
- name: Nixie-Description
in: header
description: A short description of the counter
schema:
type: string
default: ""
example: "New counter of successful responses"
- name: Nixie-Step
in: header
description: An increase or decrease step of the counter
schema:
type: integer
format: int64
default: 1
example: 4
responses:
201:
$ref: "#/components/responses/201"
500:
$ref: "#/components/responses/500"
/{key}:
parameters:
- name: key
in: path
required: true
description: The key of a specific counter.
schema:
$ref: "#/components/schemas/Key"
head:
tags:
- counter
- meta
summary: Check if a specific counter exists.
responses:
204:
$ref: "#/components/responses/204"
404:
$ref: "#/components/responses/404"
500:
$ref: "#/components/responses/500"
get:
tags:
- counter
- meta
summary: Return a value of a specific counter.
responses:
200:
$ref: "#/components/responses/200"
404:
$ref: "#/components/responses/404"
500:
$ref: "#/components/responses/500"
post:
tags:
- counter
summary: Increase or decrease a specific counter on its step and return an updated value.
responses:
200:
$ref: "#/components/responses/200"
404:
$ref: "#/components/responses/404"
500:
$ref: "#/components/responses/500"
put:
tags:
- counter
summary: Set a specific counter to a given value.
requestBody:
description: A new value for a specific counter.
required: true
content:
text/plain:
schema:
$ref: "#/components/schemas/Counter"
responses:
204:
$ref: "#/components/responses/204"
404:
$ref: "#/components/responses/404"
500:
$ref: "#/components/responses/500"
patch:
tags:
- meta
summary: Update metadata for a specific counter.
parameters:
- name: Nixie-Name
in: header
description: A human friendly name of the counter.
schema:
type: string
example: "new-response-ok"
- name: Nixie-Description
in: header
description: A short description of the counter
schema:
type: string
example: "New counter of successful responses"
- name: Nixie-Step
in: header
description: An increase or decrease step of the counter
schema:
type: integer
format: int64
example: 4
responses:
204:
$ref: "#/components/responses/204"
404:
$ref: "#/components/responses/404"
500:
$ref: "#/components/responses/500"
delete:
tags:
- counter
summary: Delete a specific counter.
responses:
204:
$ref: "#/components/responses/204"
404:
$ref: "#/components/responses/404"
500:
$ref: "#/components/responses/500"
components:
schemas:
Key:
type: string
example: "H887THUcqHcPJDjPqw6gX"
Counter:
type: integer
format: int64
example: 12
Keys:
type: array
items:
$ref: "#/components/schemas/Key"
example: |-
H887THUcqHcPJDjPqw6gX
zwAUhYjLAb7p4Qxc6iHFd
nm3kUNrG8DyJzWpgVdhRf
Error:
type: string
headers:
Nixie-Name:
description: A human friendly name of the counter
schema:
type: string
example: "response-ok"
Nixie-Description:
description: A short description of the counter
schema:
type: string
example: "Counter of successful responses"
Nixie-Step:
description: An increase or decrease step of the counter
schema:
type: integer
format: int64
examples:
increase:
value: 2
decrease:
value: -2
responses:
200:
description: Expected response to a valid request
headers:
Nixie-Name:
$ref: "#/components/headers/Nixie-Name"
Nixie-Description:
$ref: "#/components/headers/Nixie-Description"
Nixie-Step:
$ref: "#/components/headers/Nixie-Step"
content:
text/plain:
schema:
$ref: "#/components/schemas/Counter"
201:
description: Created
headers:
Nixie-Name:
$ref: "#/components/headers/Nixie-Name"
Nixie-Description:
$ref: "#/components/headers/Nixie-Description"
Nixie-Step:
$ref: "#/components/headers/Nixie-Step"
content:
text/plain:
schema:
$ref: "#/components/schemas/Key"
204:
description: No Content
headers:
Nixie-Name:
$ref: "#/components/headers/Nixie-Name"
Nixie-Description:
$ref: "#/components/headers/Nixie-Description"
Nixie-Step:
$ref: "#/components/headers/Nixie-Step"
404:
description: Not Found
content:
text/plain:
schema:
$ref: "#/components/schemas/Error"
example: "404 — Not Found"
500:
description: Internal Server Error
content:
text/plain:
schema:
$ref: "#/components/schemas/Error"
example: "500 — Internal Server Error"