-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
461 lines (461 loc) · 13.4 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
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
458
459
460
461
openapi: 3.0.0
info:
x-skaffolder-id-project: 6079a41ea3e0491123246eac
title: prmt
description: You can obtain JWT token from login API
version: 0.1
servers:
- url: http://localhost:3000/api
description: Local server for testing
paths:
/login:
post:
x-skaffolder-ignore: true
summary: Login API
security: []
tags:
- Security
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
password:
type: string
example:
username: admin
password: 62f264d7ad826f02a8af714c0a54b197935b717656b80461686d450f7b3abde4c553541515de2052b9af70f710f0cd8a1a2d3f4d60aa72608d71a63a9a93c0f5
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/User"
/verifyToken:
post:
x-skaffolder-ignore: true
summary: Verify token API
security: []
tags:
- Security
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/User"
/changePassword:
post:
x-skaffolder-ignore: true
summary: Change password API
tags:
- Security
requestBody:
content:
application/json:
schema:
type: object
properties:
passwordNew:
type: string
passwordOld:
type: string
responses:
"200":
description: OK
"/user/{id}/changePassword":
post:
x-skaffolder-id: 6079a41ea3e0491123246eb9
x-skaffolder-name: changePassword
x-skaffolder-id-resource: 6079a41ea3e0491123246eb6
x-skaffolder-resource: User
x-skaffolder-crudAction:
x-skaffolder-crudType:
x-skaffolder-description: Change password of user from admin
x-skaffolder-returnDesc:
x-skaffolder-returnType: object
x-skaffolder-url: /{id}/changePassword
x-skaffolder-roles:
- 6079a41ea3e0491123246eb8
summary: Change password of user from admin
tags:
- User
responses:
"200":
description: OK
/user:
post:
x-skaffolder-id: 6079a41ea3e0491123246ebc
x-skaffolder-name: create
x-skaffolder-id-resource: 6079a41ea3e0491123246eb6
x-skaffolder-resource: User
x-skaffolder-crudAction: create
x-skaffolder-crudType:
x-skaffolder-description: CRUD ACTION create
x-skaffolder-returnDesc:
x-skaffolder-returnType:
x-skaffolder-url: /
x-skaffolder-roles: []
summary: CRUD ACTION create
tags:
- User
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/User"
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
mail:
type: string
name:
type: string
password:
type: string
roles:
type: string
surname:
type: string
username:
type: string
get:
x-skaffolder-id: 6079a41ea3e0491123246ebe
x-skaffolder-name: list
x-skaffolder-id-resource: 6079a41ea3e0491123246eb6
x-skaffolder-resource: User
x-skaffolder-crudAction: list
x-skaffolder-crudType:
x-skaffolder-description: CRUD ACTION list
x-skaffolder-returnDesc:
x-skaffolder-returnType:
x-skaffolder-url: /
x-skaffolder-roles: []
summary: CRUD ACTION list
tags:
- User
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/User"
"/user/{id}":
delete:
x-skaffolder-id: 6079a41ea3e0491123246ec0
x-skaffolder-name: delete
x-skaffolder-id-resource: 6079a41ea3e0491123246eb6
x-skaffolder-resource: User
x-skaffolder-crudAction: delete
x-skaffolder-crudType:
x-skaffolder-description: CRUD ACTION delete
x-skaffolder-returnDesc:
x-skaffolder-returnType:
x-skaffolder-url: /{id}
x-skaffolder-roles: []
summary: CRUD ACTION delete
tags:
- User
parameters:
- name: id
x-skaffolder-type: ObjectId
in: path
description: Id
required: true
schema:
type: string
responses:
"200":
description: OK
get:
x-skaffolder-id: 6079a41ea3e0491123246eba
x-skaffolder-name: get
x-skaffolder-id-resource: 6079a41ea3e0491123246eb6
x-skaffolder-resource: User
x-skaffolder-crudAction: get
x-skaffolder-crudType:
x-skaffolder-description: CRUD ACTION get
x-skaffolder-returnDesc:
x-skaffolder-returnType:
x-skaffolder-url: /{id}
x-skaffolder-roles: []
summary: CRUD ACTION get
tags:
- User
parameters:
- name: id
x-skaffolder-type: ObjectId
in: path
description: Id resource
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/User"
post:
x-skaffolder-id: 6079a41ea3e0491123246ebb
x-skaffolder-name: update
x-skaffolder-id-resource: 6079a41ea3e0491123246eb6
x-skaffolder-resource: User
x-skaffolder-crudAction: update
x-skaffolder-crudType:
x-skaffolder-description: CRUD ACTION update
x-skaffolder-returnDesc:
x-skaffolder-returnType:
x-skaffolder-url: /{id}
x-skaffolder-roles: []
summary: CRUD ACTION update
tags:
- User
parameters:
- name: id
x-skaffolder-type: ObjectId
in: path
description: Id
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/User"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/User"
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
Team:
x-skaffolder-id: 6079a656a3e0491123246edf
x-skaffolder-id-db: 6079a41ea3e0491123246ead
x-skaffolder-id-entity: 6079a656a3e0491123246edd
x-skaffolder-url: /team
properties:
_id:
type: string
x-skaffolder-required: true
teamname:
type: string
x-skaffolder-id-attr: 6079a656a3e0491123246ede
x-skaffolder-type: String
x-skaffolder-relations:
required:
- _id
User:
x-skaffolder-id: 6079a41ea3e0491123246eb6
x-skaffolder-id-db: 6079a41ea3e0491123246ead
x-skaffolder-id-entity: 6079a41ea3e0491123246eae
x-skaffolder-url: /user
x-skaffolder-type: User
properties:
_id:
type: string
x-skaffolder-required: true
mail:
type: string
x-skaffolder-id-attr: 6079a41ea3e0491123246eb1
x-skaffolder-type: String
name:
type: string
x-skaffolder-id-attr: 6079a41ea3e0491123246eb2
x-skaffolder-type: String
password:
type: string
x-skaffolder-id-attr: 6079a41ea3e0491123246eb0
x-skaffolder-type: String
x-skaffolder-required: true
roles:
type: string
x-skaffolder-id-attr: 6079a41ea3e0491123246eb4
x-skaffolder-type: String
surname:
type: string
x-skaffolder-id-attr: 6079a41ea3e0491123246eb3
x-skaffolder-type: String
username:
type: string
x-skaffolder-id-attr: 6079a41ea3e0491123246eaf
x-skaffolder-type: String
x-skaffolder-required: true
x-skaffolder-relations:
roles:
x-skaffolder-id: 6079fb3ea3e0491123247015
x-skaffolder-type: 1:m
x-skaffolder-ent1: 6079a41ea3e0491123246eae
x-skaffolder-ent2: 6079a641a3e0491123246ed7
required:
- _id
- password
- username
projects:
x-skaffolder-id: 607a0435a3e0491123247036
x-skaffolder-id-db: 6079a41ea3e0491123246ead
x-skaffolder-id-entity: 607a0435a3e0491123247024
x-skaffolder-url: /projects
properties:
_id:
type: string
x-skaffolder-required: true
projApproval:
type: object
x-skaffolder-id-attr: 607a0435a3e0491123247035
x-skaffolder-type: Custom
projAreaAccess:
type: string
x-skaffolder-id-attr: 607a0435a3e0491123247031
x-skaffolder-type: String
projCoordinator:
type: string
x-skaffolder-id-attr: 607a0435a3e0491123247028
x-skaffolder-type: String
projCoordinatorEmail:
type: string
x-skaffolder-id-attr: 607a0435a3e049112324702a
x-skaffolder-type: String
projCoordinatorTel:
type: number
x-skaffolder-id-attr: 607a0435a3e0491123247029
x-skaffolder-type: Number
projDateSubmitted:
type: integer
x-skaffolder-id-attr: 607a0435a3e0491123247025
x-skaffolder-type: Date
projDesc:
type: string
x-skaffolder-id-attr: 607a0435a3e0491123247032
x-skaffolder-type: String
projEndDate:
type: integer
x-skaffolder-id-attr: 607a0435a3e0491123247034
x-skaffolder-type: Date
projGeneralContractor:
type: string
x-skaffolder-id-attr: 607a0435a3e049112324702b
x-skaffolder-type: String
projGeneralContractorSupervisor:
type: string
x-skaffolder-id-attr: 607a0435a3e049112324702c
x-skaffolder-type: String
projGeneralContractorSupervisorEmail:
type: string
x-skaffolder-id-attr: 607a0435a3e049112324702e
x-skaffolder-type: String
projGeneralContractorSupervisorTel:
type: number
x-skaffolder-id-attr: 607a0435a3e049112324702d
x-skaffolder-type: Number
projManager:
type: string
x-skaffolder-id-attr: 607a0435a3e0491123247027
x-skaffolder-type: String
projName:
type: string
x-skaffolder-id-attr: 607a0435a3e0491123247026
x-skaffolder-type: String
projStartDate:
type: integer
x-skaffolder-id-attr: 607a0435a3e0491123247033
x-skaffolder-type: Date
projType:
type: object
x-skaffolder-id-attr: 607a0435a3e049112324702f
x-skaffolder-type: Custom
projectArea:
type: string
x-skaffolder-id-attr: 607a0435a3e0491123247030
x-skaffolder-type: String
x-skaffolder-relations:
required:
- _id
roles:
x-skaffolder-id: 6079a641a3e0491123246eda
x-skaffolder-id-db: 6079a41ea3e0491123246ead
x-skaffolder-id-entity: 6079a641a3e0491123246ed7
x-skaffolder-url: /role
properties:
_id:
type: string
x-skaffolder-required: true
rolename:
type: string
x-skaffolder-id-attr: 6079a641a3e0491123246ed8
x-skaffolder-type: String
teamname:
type: string
x-skaffolder-id-attr: 6079a641a3e0491123246ed9
x-skaffolder-type: String
x-skaffolder-relations:
rolename:
x-skaffolder-id: 6079fb57a3e0491123247016
x-skaffolder-type: 1:m
x-skaffolder-ent1: 6079a641a3e0491123246ed7
x-skaffolder-ent2: 6079a641a3e0491123246ed7
required:
- _id
x-skaffolder-db:
- x-skaffolder-id: 6079a41ea3e0491123246ead
x-skaffolder-name: prmt_db
x-skaffolder-page:
- x-skaffolder-id: 6079a41ea3e0491123246eb5
x-skaffolder-name: Home
x-skaffolder-url: /login
x-skaffolder-template:
x-skaffolder-resource:
x-skaffolder-services:
- 6079a41ea3e0491123246eba
- 6079a41ea3e0491123246ebc
- 6079a41ea3e0491123246ebb
x-skaffolder-nesteds:
x-skaffolder-links:
x-skaffolder-roles: []
- x-skaffolder-id: 6079a6f1a3e0491123246ee5
x-skaffolder-name: ProjectList
x-skaffolder-url: /projects
x-skaffolder-template: List_Crud
x-skaffolder-resource: 6079a5dfa3e0491123246ed3
x-skaffolder-services:
x-skaffolder-nesteds:
x-skaffolder-links:
- 6079a41ea3e0491123246eb5
x-skaffolder-roles:
- x-skaffolder-id: 6079a41ea3e0491123246eb8
x-skaffolder-name: ADMIN