-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
146 lines (145 loc) · 3.66 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
openapi: '3.1.0'
info:
title: Users App API
description: a RESTful API that allows users to create, retrieve, update, and delete data on a PostgreSQL database
version: '1.0.0'
servers:
- url: http://localhost:8000
paths:
/:
get:
description: Home
responses:
'200':
description: OK
/login:
post:
security:
- bearerAuth: []
description: Login as a user
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
responses:
'200':
description: OK
'400':
$ref: '#/components/responses/BadRequestError'
'500':
$ref: '#/components/responses/InternalServerError'
/users:
get:
security:
- bearerAuth: []
description: List of users
responses:
'200':
description: OK
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'500':
$ref: '#/components/responses/InternalServerError'
/users/create:
post:
description: Create a user
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
email:
type: string
format: email
password:
type: string
responses:
'200':
description: OK
'400':
$ref: '#/components/responses/BadRequestError'
'500':
$ref: '#/components/responses/InternalServerError'
/users/update:
patch:
security:
- bearerAuth: []
description: Update a user
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
email:
type: string
format: email
password:
type: string
responses:
'200':
description: OK
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'500':
$ref: '#/components/responses/InternalServerError'
/users/delete:
delete:
security:
- bearerAuth: []
description: Delete a user
parameters:
- in: query
name: email
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'500':
$ref: '#/components/responses/InternalServerError'
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
responses:
BadRequestError:
description: Bad request or input validation error
UnauthorizedError:
description: JWT token is missing
ForbiddenError:
description: JWT token is invalid
InternalServerError:
description: Unexpected error
security:
- bearerAuth: []