-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
151 lines (143 loc) · 2.8 KB
/
swagger.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
tags:
- name: users
description: users API
- name: tours
description: tours API
paths:
# [GET] users
/api/v1/users:
get:
tags:
- users
summary: Find All Users
responses:
200:
description: 'OK'
500:
description: 'Server Error'
# [GET] users
/api/v1/tours:
get:
tags:
- tours
summary: Find All Tours
responses:
200:
description: 'OK'
500:
description: 'Server Error'
# [POST] users
post:
tags:
- users
summary: Add User
parameters:
- name: body
in: body
description: user Data
required: true
schema:
$ref: '#/definitions/users'
responses:
418:
description: 'This route is not yet defined! Please use /signup instead'
500:
description: 'Server Error'
# [GET] users/id
/api/v1/users/{id}:
get:
tags:
- users
summary: Find All Users
parameters:
- name: id
in: path
description: User Id
required: true
responses:
200:
description: 'OK'
409:
description: 'Conflict'
500:
description: 'Server Error'
# [PUT] users/id
put:
tags:
- users
summary: Update User By Id
parameters:
- name: id
in: path
description: user Id
required: true
- name: body
in: body
description: user Data
required: true
schema:
$ref: '#/definitions/users'
responses:
200:
description: 'OK'
400:
description: 'Bad Request'
409:
description: 'Conflict'
500:
description: 'Server Error'
# [DELETE] users/id
delete:
tags:
- users
summary: Delete User By Id
parameters:
- name: id
in: path
description: user Id
required: true
responses:
204:
description: 'OK'
409:
description: 'Conflict'
500:
description: 'Server Error'
# definitions
definitions:
users:
type: object
required:
- id
- name
- email
- password
- role
- passwordConfirm
properties:
id:
description: user Id
name:
type: string
email:
type: string
photo:
type: string
role:
type: string
enum: ['user', 'guide', 'lead-guide', 'admin']
password:
type: string
passwordConfirm:
type: string
passwordChangedAt:
type: date
passwordResetToken:
type: string
passwordResetExpire:
type: datae
active:
type: boolean
schemes:
- https
- http