-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
427 lines (425 loc) · 10.5 KB
/
api.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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
openapi: 3.0.2
servers:
- url: /api
info:
version: 3.0.0
title: GripMock API Schema
tags:
- name: stubs
description: Stubs storage management
- name: services
description: Services reflection
- name: dashboard
description: Dashboard
- name: healthcheck
description: Healthcheck
paths:
# healthcheck
/health/liveness:
get:
tags:
- healthcheck
summary: Liveness check
description: The test says that the service is alive and yet
operationId: liveness
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/MessageOK'
/health/readiness:
get:
tags:
- healthcheck
summary: Readiness check
description: The test indicates readiness to receive traffic
operationId: readiness
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/MessageOK'
# internal
/services:
get:
tags:
- services
summary: Services
description: List of registered services
operationId: servicesList
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Service'
/services/{serviceID}/methods:
get:
tags:
- services
summary: Service methods
description: List of registered service methods
operationId: serviceMethodsList
parameters:
- name: serviceID
in: path
description: ID of service
required: true
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Method'
# stubs
/stubs/used:
get:
tags:
- stubs
summary: Getting a list of used stubs
description: The list is needed to quickly find used stubs
operationId: listUsedStubs
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StubList'
/stubs/unused:
get:
tags:
- stubs
summary: Getting a list of unused stubs
description: The list is needed to quickly find unused stubs
operationId: listUnusedStubs
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StubList'
/stubs:
get:
tags:
- stubs
summary: Getting a list of stubs
description: The list of stubs is required to view all added stubs
operationId: listStubs
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/StubList'
post:
tags:
- stubs
summary: Add a new stub to the store
description: Add a new stub to the store
operationId: addStub
responses:
'200':
description: Successful operation
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ListID'
requestBody:
description: Create a new pet in the store
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/StubList'
- $ref: '#/components/schemas/Stub'
delete:
tags:
- stubs
summary: Remove all stubs
description: Completely clears the stub storage
operationId: purgeStubs
responses:
'204':
description: Successful operation
/stubs/batchDelete:
post:
tags:
- stubs
summary: Deletes a pack by IDs
description: Takes IDs as input and deletes them
operationId: batchStubsDelete
responses:
'204':
description: Successful operation
requestBody:
description: Create a new pet in the store
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListID'
'/stubs/{uuid}':
get:
tags:
- stubs
summary: Get Stub by ID
description: Searches for Stub by ID
operationId: findByID
parameters:
- name: uuid
in: path
description: ID of stub
required: true
schema:
$ref: '#/components/schemas/ID'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Stub'
delete:
tags:
- stubs
summary: Deletes stub by ID
description: The method removes the stub by ID
operationId: deleteStubByID
parameters:
- name: uuid
in: path
description: ID of stub
required: true
schema:
$ref: '#/components/schemas/ID'
responses:
'204':
description: successful operation
'/stubs/search':
post:
tags:
- stubs
summary: Stub storage search
description: Performs a search for a stub by the given conditions
operationId: searchStubs
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/SearchResponse'
requestBody:
description: Description of filtering
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SearchRequest'
components:
schemas:
# health
MessageOK:
type: object
required:
- message
- time
properties:
message:
type: string
time:
type: string
format: date-time
# services
Service:
type: object
required:
- id
- package
- name
- methods
properties:
id:
type: string
package:
type: string
name:
type: string
methods:
type: array
items:
$ref: '#/components/schemas/Method'
Method:
type: object
required:
- id
- name
properties:
id:
type: string
name:
type: string
# stubs
ID:
type: string
format: uuid
example: 51c50050-ec27-4dae-a583-a32ca71a1dd5
ListID:
type: array
items:
$ref: '#/components/schemas/ID'
StubList:
type: array
items:
$ref: '#/components/schemas/Stub'
SearchRequest:
type: object
required:
- service
- method
- data
properties:
id:
$ref: '#/components/schemas/ID'
service:
type: string
example: Gripmock
method:
type: string
example: SayHello
headers:
type: object
additionalProperties:
type: string
x-go-type-skip-optional-pointer: true
data:
type: object
x-go-type: interface{}
additionalProperties: true
SearchResponse:
type: object
required:
- data
- error
properties:
headers:
type: object
additionalProperties:
type: string
x-go-type-skip-optional-pointer: true
data:
type: object
x-go-type: interface{}
additionalProperties: true
error:
type: string
example: Message not found
code:
type: integer
format: uint32
x-go-type: codes.Code
x-go-type-import:
name: codes
path: google.golang.org/grpc/codes
example: 3
Stub:
type: object
required:
- service
- method
- input
- output
properties:
id:
$ref: '#/components/schemas/ID'
service:
type: string
example: Gripmock
method:
type: string
example: SayHello
headers:
$ref: '#/components/schemas/StubHeaders'
input:
$ref: '#/components/schemas/StubInput'
output:
$ref: '#/components/schemas/StubOutput'
StubInput:
type: object
properties:
ignoreArrayOrder:
type: boolean
default: false
equals:
type: object
additionalProperties: true
x-go-type-skip-optional-pointer: true
contains:
type: object
additionalProperties: true
x-go-type-skip-optional-pointer: true
matches:
type: object
additionalProperties: true
x-go-type-skip-optional-pointer: true
StubHeaders:
type: object
x-go-type-skip-optional-pointer: true
properties:
equals:
type: object
additionalProperties:
type: string
x-go-type-skip-optional-pointer: true
contains:
type: object
additionalProperties:
type: string
x-go-type-skip-optional-pointer: true
matches:
type: object
additionalProperties:
type: string
x-go-type-skip-optional-pointer: true
StubOutput:
type: object
required:
- data
- error
properties:
data:
type: object
additionalProperties: true
headers:
type: object
additionalProperties:
type: string
x-go-type-skip-optional-pointer: true
error:
type: string
example: Message not found
code:
type: integer
format: uint32
x-go-type: codes.Code
x-go-type-import:
name: codes
path: google.golang.org/grpc/codes
example: 3