-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathopenapi.yaml
242 lines (242 loc) · 6.28 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
openapi: 3.0.3
info:
title: Auth API
description: |-
Ini adalah Auth API untuk tugas Open API
contact:
name: Habib
email: habib@alterra.id
url: https://habib.com
version: 1.0.0
servers:
- url: https://test.habib.com
description: development server
- url: https://habib.com
description: production server
- url: https://legacy.habib.com/{versi}
description: legacy servers
variables:
versi:
default: v1
enum:
- v1
- v2
- v3
tags:
- name: Auth
- name: User
paths:
/register:
post:
tags:
- "Auth"
- "User"
description: Endpoint to insert a new user
summary: Insert a new user
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
email:
type: string
format: email
password:
type: string
format: password
example:
name: Habib
email: habib@alterra.id
password: habib123
responses:
201:
description: "Inserted a new user successfully"
content:
application/json:
schema:
type: object
properties:
message:
type: string
example:
message: "Registered successfully"
400:
$ref: '#/components/responses/400'
500:
$ref: '#/components/responses/500'
/login:
post:
tags:
- "Auth"
- "User"
description: Endpoint to get the session
summary: Logs user into the system
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
password:
type: string
format: password
responses:
200:
description: "Logged in successfully"
content:
application/json:
schema:
$ref: '#/components/schemas/responseObject'
example:
data:
message: "Logged in successfully"
403:
description: "Invalid user input"
content:
application/json:
schema:
type: object
properties:
message:
type: string
example:
message: "email/password doesn't match"
400:
$ref: '#/components/responses/400'
500:
$ref: '#/components/responses/500'
/user/{id}:
get:
tags:
- User
summary: Get user by id
description: get a user data with id as parameter
operationId: getUserByName
parameters:
- name: id
in: path
description: 'Insert a user id to get the data'
required: true
schema:
type: integer
responses:
200:
description: "sukses melihat data"
content:
application/json:
schema:
$ref: '#/components/schemas/responseObject'
example:
data:
id: 1
name: Habib
email: habib@alterra.id
password: habib123
message: showed a user data successfully
400:
$ref: '#/components/responses/400'
500:
$ref: '#/components/responses/500'
put:
tags:
- User
summary: Update a user data
description: This can only be done by the logged in user.
operationId: updateUser
parameters:
- name: id
in: path
description: id user that need to be updated
required: true
schema:
type: integer
requestBody:
description: Update an existent user in the store
content:
application/json:
schema:
$ref: '#/components/schemas/responseObject'
example:
data:
id: 1
name: Habibullah
email: habib@alterra.id
password: habib123
responses:
default:
description: Updated a user data successfully
200:
description: "Updated a user data successfully"
content:
application/json:
schema:
$ref: '#/components/schemas/responseObject'
example:
data:
id: 1
name: Habibullah
email: habib@alterra.id
password: habib123
message: "Updated a user data successfully"
400:
$ref: '#/components/responses/400'
500:
$ref: '#/components/responses/500'
delete:
tags:
- User
summary: Delete user
description: This can only be done by the logged in user.
operationId: deleteUser
parameters:
- name: id
in: path
description: The id that needs to be deleted
required: true
schema:
type: integer
responses:
default:
description: deleted a user successfully
'400':
description: Invalid id user input
'404':
description: id user not found
components:
schemas:
responseObject:
type: object
properties:
data:
type: object
message:
type: string
responses:
400:
description: "Client's side error"
content:
application/json:
schema:
type: object
properties:
message:
type: string
example:
message: "Invalid user input"
500:
description: "Server's side error"
content:
application/json:
schema:
type: object
properties:
message:
type: string
example:
message: "Unable to process the data"