-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
executable file
·276 lines (276 loc) · 6.37 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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
openapi: 3.0.2
info:
title: Web app
version: '1.0'
paths:
/user/registry:
post:
summary: Register User
operationId: register_user_user_registry_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUser'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DisplayUser'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/user/auth:
post:
summary: Authenticate User
operationId: authenticate_user_user_auth_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthUser'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/user/{user_id}:
get:
summary: Get User Data
operationId: get_user_data_user__user_id__get
parameters:
- required: true
schema:
title: User Id
type: integer
name: user_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DisplayUser'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/offer/create:
post:
summary: Create Offer
operationId: create_offer_offer_create_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOffer'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Offer'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/offer/:
post:
summary: Get Offer
operationId: get_offer_offer__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OfferRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
title: Response Get Offer Offer Post
anyOf:
- $ref: '#/components/schemas/Offer'
- type: array
items:
$ref: '#/components/schemas/Offer'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
AuthResponse:
title: AuthResponse
required:
- id
- access_token
- refresh_token
type: object
properties:
id:
title: Id
type: integer
access_token:
title: Access Token
type: string
refresh_token:
title: Refresh Token
type: string
AuthUser:
title: AuthUser
required:
- username
- password
type: object
properties:
username:
title: Username
type: string
password:
title: Password
type: string
CreateOffer:
title: CreateOffer
required:
- title
- text
- user_id
type: object
properties:
title:
title: Title
type: string
text:
title: Text
type: string
user_id:
title: User Id
type: integer
CreateUser:
title: CreateUser
required:
- email
- username
- password
type: object
properties:
email:
title: Email
type: string
format: email
username:
title: Username
type: string
password:
title: Password
type: string
DisplayUser:
title: DisplayUser
required:
- email
- username
- id
- offers
type: object
properties:
email:
title: Email
type: string
format: email
username:
title: Username
type: string
id:
title: Id
type: integer
offers:
title: Offers
type: array
items:
$ref: '#/components/schemas/Offer'
HTTPValidationError:
title: HTTPValidationError
type: object
properties:
detail:
title: Detail
type: array
items:
$ref: '#/components/schemas/ValidationError'
Offer:
title: Offer
required:
- title
- text
- user_id
- id
type: object
properties:
title:
title: Title
type: string
text:
title: Text
type: string
user_id:
title: User Id
type: integer
id:
title: Id
type: integer
OfferRequest:
title: OfferRequest
type: object
properties:
user_id:
title: User Id
type: integer
offer_id:
title: Offer Id
type: integer
ValidationError:
title: ValidationError
required:
- loc
- msg
- type
type: object
properties:
loc:
title: Location
type: array
items:
type: string
msg:
title: Message
type: string
type:
title: Error Type
type: string