-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiDocumentation.yaml
255 lines (212 loc) · 6.55 KB
/
apiDocumentation.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
openapi: 3.0.3
info:
title: TestTask
version: 0.0.1
paths:
/getPage:
get:
description: получение данных с возможностью пагинаци и фильтрации.
parameters:
- name: limit
description: "лимитирует возвращаемые значения"
in: query
required: true
schema:
type: integer
- name: pastId
description: "используется для корректной пагинации. Примает последней id машины, которая была получена ранее"
in: query
required: false
schema:
type: integer
- name: markFilter
description: "фильтрует машины по маркам"
in: query
required: false
schema:
type: array
items:
type: string
- name: modelFilter
description: "фильтрует машины по моделям"
in: query
required: false
schema:
type: array
items:
type: string
- name: yearsFilter
description: "фильтрует машины по году выпуска"
in: query
required: false
schema:
type: array
items:
type: integer
- name: periodStart
description: "фильтрует машины по году от первого заданаго числа в periodStart до последнего заданго числа в periodEnd. Нельзя использовать вместе с yearsFilter"
in: query
required: false
schema:
type: integer
- name: periodEnd
in: query
required: false
schema:
type: integer
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
required:
- carArray
properties:
carArray:
type: array
items:
$ref: '#/components/schemas/Car'
'400':
description: Bad request
'500':
description: Iteranl server error
/addCars:
post:
description: добавляет машины или машину в бд по номеру. Может вернуть массив с не добавлеными номерами и причиной.
requestBody:
content:
application/json:
schema:
type: object
required:
- regNums
properties:
regNums:
type: array
items:
type: string
responses:
'201':
description: created
content:
application/json:
schema:
$ref: '#/components/schemas/NotAddedRegNums'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/NotAddedRegNums'
'500':
description: iternal server error
content:
application/json:
schema:
$ref: '#/components/schemas/NotAddedRegNums'
/editCar/{regNum}:
patch:
description: изменение данных у указаной машиный через номер. В request body передаются поля которые подлежат изменению.
parameters:
- name: regNum
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
mark:
type: string
model:
type: string
year:
type: integer
owner:
$ref: '#/components/schemas/Person'
responses:
'200':
description: Edited
'404':
description: Not found
'400':
description: Bad request
'500':
description: Iternal server error
/deleteCar/{regNum}:
delete:
parameters:
- name: regNum
in: path
required: true
schema:
type: string
responses:
'200':
description: Delted
'404':
description: Not found
components:
schemas:
NotAddedRegNums:
description: Вложеный массив строк, который содержит два значения. Первое, номер машины которая была не добавлена, второе, причина почему была эта машина не добавлена.
required:
- notAddedRegNums
properties:
notAddedRegNums:
type: array
items:
type: array
items:
type: string
example:
[
["E290KX170", "Invalid data"],
["E291MP39", "Iteranl error"],
["O783EX77", "Car exists"]
]
Car:
type: object
required:
- id
- regNum
- mark
- model
- year
- owner
properties:
id:
type: integer
example: 352
regNum:
type: string
example: X123XX150
mark:
type: string
example: Lada
model:
type: string
example: Vesta
year:
type: integer
example: 2002
owner:
$ref: '#/components/schemas/Person'
Person:
type: object
required:
- name
- surname
- patranomic
properties:
name:
type: string
surname:
type: string
patranomic:
type: string