-
Notifications
You must be signed in to change notification settings - Fork 1
/
specs-ad-v1.yaml
457 lines (419 loc) · 12.3 KB
/
specs-ad-v1.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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
openapi: 3.0.3
info:
title: "Marketplace ${VERSION_APP}"
description: This is a place where sellers and buyers meat each other
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
servers:
- url: http://localhost:8080/v1
tags:
- name: ad
description: Объявление (о покупке или продаже)
paths:
/ad/create:
post:
tags:
- ad
summary: Create ad
operationId: adCreate
requestBody:
description: Request body
content:
application/json:
schema:
$ref: '#/components/schemas/AdCreateRequest'
required: true
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdCreateResponse'
/ad/read:
post:
tags:
- ad
summary: Read ad
operationId: adRead
requestBody:
description: Request body
content:
application/json:
schema:
$ref: '#/components/schemas/AdReadRequest'
required: true
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdReadResponse'
/ad/update:
post:
tags:
- ad
summary: Update ad
operationId: adUpdate
requestBody:
description: Request body
content:
application/json:
schema:
$ref: '#/components/schemas/AdUpdateRequest'
required: true
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdUpdateResponse'
/ad/delete:
post:
tags:
- ad
summary: Delete ad
operationId: adDelete
requestBody:
description: Request body
content:
application/json:
schema:
$ref: '#/components/schemas/AdDeleteRequest'
required: true
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdDeleteResponse'
/ad/search:
post:
tags:
- ad
summary: Search ad
operationId: adSearch
requestBody:
description: Request body
content:
application/json:
schema:
$ref: '#/components/schemas/AdSearchRequest'
required: true
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdSearchResponse'
/ad/offers:
post:
tags:
- ad
summary: Search offers
operationId: adOffers
requestBody:
description: Request body
content:
application/json:
schema:
$ref: '#/components/schemas/AdOffersRequest'
required: true
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AdOffersResponse'
components:
schemas:
IRequest:
type: object
description: Базовый интерфейс для всех запросов
properties:
requestType:
type: string
description: Поле-дескриминатор для вычисления типа запроса
example: create
discriminator:
propertyName: requestType
mapping:
create: '#/components/schemas/AdCreateRequest'
read: '#/components/schemas/AdReadRequest'
update: '#/components/schemas/AdUpdateRequest'
delete: '#/components/schemas/AdDeleteRequest'
search: '#/components/schemas/AdSearchRequest'
offers: '#/components/schemas/AdOffersRequest'
Error:
type: object
properties:
code:
type: string
group:
type: string
field:
type: string
message:
type: string
ResponseResult:
type: string
enum:
- success
- error
IResponse:
type: object
description: Базовый интерфейс для всех ответов
properties:
responseType:
type: string
description: Поле-дескриминатор для вычисления типа запроса
example: create
result:
$ref: '#/components/schemas/ResponseResult'
errors:
type: array
items:
$ref: '#/components/schemas/Error'
discriminator:
propertyName: responseType
mapping:
create: '#/components/schemas/AdCreateResponse'
read: '#/components/schemas/AdReadResponse'
update: '#/components/schemas/AdUpdateResponse'
delete: '#/components/schemas/AdDeleteResponse'
search: '#/components/schemas/AdSearchResponse'
offers: '#/components/schemas/AdOffersResponse'
init: '#/components/schemas/AdInitResponse'
UserId:
type: string
description: Идентификатор пользователя
AdId:
type: string
description: Идентификатор объявления
AdLock:
type: string
description: Версия оптимистичной блокировки
BaseAd:
type: object
description: Объект описывает свойства, одинаковые для create и update
properties:
title:
type: string
description: Заголовок объявления
description:
type: string
description: Описание объявления
adType:
$ref: '#/components/schemas/DealSide'
visibility:
$ref: '#/components/schemas/AdVisibility'
DealSide:
type: string
description: 'Сторона сделки: спрос или предложение'
enum:
- demand
- supply
AdVisibility:
type: string
description: 'Тип видимости объявления. Возможные значения: видит только владелец, только зарегистрированный в
системе пользователь, видимо всем'
enum:
- ownerOnly
- registeredOnly
- public
AdInitResponse:
allOf:
- $ref: '#/components/schemas/IResponse'
AdCreateObject:
allOf:
- $ref: '#/components/schemas/BaseAd'
AdCreateRequest:
allOf:
- $ref: '#/components/schemas/IRequest'
- $ref: '#/components/schemas/AdRequestDebug'
- type: object
properties:
ad:
$ref: '#/components/schemas/AdCreateObject'
AdReadObject:
allOf:
- type: object
properties:
id:
$ref: '#/components/schemas/AdId'
AdReadRequest:
allOf:
- $ref: '#/components/schemas/IRequest'
- $ref: '#/components/schemas/AdRequestDebug'
- type: object
properties:
ad:
$ref: '#/components/schemas/AdReadObject'
AdUpdateObject:
allOf:
- $ref: '#/components/schemas/BaseAd'
- type: object
properties:
id:
$ref: '#/components/schemas/AdId'
lock:
$ref: '#/components/schemas/AdLock'
AdUpdateRequest:
allOf:
- $ref: '#/components/schemas/IRequest'
- $ref: '#/components/schemas/AdRequestDebug'
- type: object
properties:
ad:
$ref: '#/components/schemas/AdUpdateObject'
AdDeleteObject:
allOf:
- type: object
properties:
id:
$ref: '#/components/schemas/AdId'
lock:
$ref: '#/components/schemas/AdLock'
AdDeleteRequest:
allOf:
- $ref: '#/components/schemas/IRequest'
- $ref: '#/components/schemas/AdRequestDebug'
- type: object
properties:
ad:
$ref: '#/components/schemas/AdDeleteObject'
AdSearchFilter:
type: object
description: Набор фильтров для поиска
properties:
searchString:
type: string
description: Поисковая строка, которая будет искаться в объявлениях
ownerId:
$ref: '#/components/schemas/UserId'
adType:
$ref: '#/components/schemas/DealSide'
AdSearchRequest:
allOf:
- $ref: '#/components/schemas/IRequest'
- $ref: '#/components/schemas/AdRequestDebug'
- type: object
properties:
adFilter:
$ref: '#/components/schemas/AdSearchFilter'
AdOffersObject:
$ref: '#/components/schemas/AdReadObject'
AdOffersRequest:
allOf:
- $ref: '#/components/schemas/IRequest'
- $ref: '#/components/schemas/AdRequestDebug'
- type: object
properties:
ad:
$ref: '#/components/schemas/AdOffersObject'
AdResponseObject:
allOf:
- $ref: '#/components/schemas/BaseAd'
- type: object
description: Объект, который возвращается в ответе бэкенда
properties:
id:
$ref: '#/components/schemas/AdId'
ownerId:
$ref: '#/components/schemas/UserId'
lock:
$ref: '#/components/schemas/AdLock'
permissions:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/AdPermissions'
AdPermissions:
type: string
description: Доступы для клиента для операций над объявлением
enum:
- read
- update
- delete
- makeVisiblePublic
- makeVisibleOwn
- makeVisibleGroup
AdResponseSingle:
allOf:
- type: object
description: Ответ с одним объектом объявления
properties:
ad:
$ref: '#/components/schemas/AdResponseObject'
AdResponseMulti:
allOf:
- type: object
description: Список найденных объектов
properties:
ads:
type: array
items:
$ref: '#/components/schemas/AdResponseObject'
AdCreateResponse:
allOf:
- $ref: '#/components/schemas/IResponse'
- $ref: '#/components/schemas/AdResponseSingle'
AdReadResponse:
allOf:
- $ref: '#/components/schemas/IResponse'
- $ref: '#/components/schemas/AdResponseSingle'
AdUpdateResponse:
allOf:
- $ref: '#/components/schemas/IResponse'
- $ref: '#/components/schemas/AdResponseSingle'
AdDeleteResponse:
allOf:
- $ref: '#/components/schemas/IResponse'
- $ref: '#/components/schemas/AdResponseSingle'
AdSearchResponse:
allOf:
- $ref: '#/components/schemas/IResponse'
- $ref: '#/components/schemas/AdResponseMulti'
AdOffersResponse:
allOf:
- $ref: '#/components/schemas/IResponse'
- $ref: '#/components/schemas/AdResponseSingle'
- $ref: '#/components/schemas/AdResponseMulti'
# STUBS ======================
AdRequestDebugMode:
type: string
enum:
- prod
- test
- stub
AdRequestDebug:
type: object
properties:
debug:
$ref: '#/components/schemas/AdDebug'
AdDebug:
type: object
properties:
mode:
$ref: '#/components/schemas/AdRequestDebugMode'
stub:
$ref: '#/components/schemas/AdRequestDebugStubs'
AdRequestDebugStubs:
type: string
description: Перечисления всех стабов
enum:
- success
- notFound
- badId
- badTitle
- badDescription
- badVisibility
- cannotDelete
- badSearchString