/
swagger.js
271 lines (271 loc) · 8.68 KB
/
swagger.js
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
module.exports = {
swagger: "2.0",
info: {
version: "1",
title: "SEND IT API",
description: "An API for making and sending parcel delivery orders"
},
schemes: ["https"],
host: "https://sendit-pro.herokuapp.com/",
basePath: "/api/v1/",
tags: [
{
name: "Auth",
description: "Authenticate a user"
}
],
paths: {
"/auth/login": {
post: {
tags: ["Auth"],
summary: "Login to the API to get authentication token",
consumes: ["application/x-www-form-urlencoded"],
parameters: [
{
name: "email",
in: "formData",
description: "The email for login",
required: true,
type: "string"
},
{
name: "password",
in: "formData",
description: "The password for login in text",
required: true,
type: "string"
}
],
description: "Returns an authentication token on success.",
responses: {
"200": {
description:
"Authentication Successful, return user details and token"
},
"400": {
description: "Wrong Password and Email Combination"
}
}
}
},
"/auth/signup": {
post: {
tags: ["Auth"],
summary: "Create an account for a new user on the API",
description: "Returns success 201 on success.",
consumes: ["application/x-www-form-urlencoded"],
parameters: [
{
name: "firstname",
in: "formData",
description:
"The firstname of the user account to be created",
required: true,
type: "string"
},
{
name: "lastname",
in: "formData",
description:
"The lastname for the user account to be created",
required: true,
type: "string"
},
{
name: "othernames",
in: "formData",
description:
"The other name of the user to be created",
required: false,
type: "string"
},
{
name: "email",
in: "formData",
description:
"The email of the user account to be created",
required: true,
type: "string"
},
{
name: "username",
in: "formData",
description:
"The username of the user account to be created",
required: true,
type: "string"
},
{
name: "password",
in: "formData",
description:
"The password for the user account to be created",
required: true,
type: "string"
}
],
responses: {
"201": {
description: "New User created successfully",
schema: {
$ref: "#/definitions/User"
}
},
"400": {
description: "User Already Exists"
},
"500": {
description: "Error Saving User"
}
}
}
},
"/parcels": {
post: {
tags: ["Parcels"],
summary: "Work with parcel delivery orders",
consumes: ["application/x-www-form-urlencoded"],
parameters: [
{
name: "Bearer",
in: "header",
description: "Authorization token",
required: true,
type: "string"
},
{
name: "weight",
in: "formData",
description: "The newpassword to be changed",
required: true,
type: "number"
},
{
name: "fromAddress",
in: "formData",
description: "The verified token",
required: true,
type: "string"
},
{
name: "toddress",
in: "formData",
description: "The verified token",
required: true,
type: "string"
}
],
description: "Create a new parcel delivery order",
responses: {
"200": {
description: "Parcel created Successfully"
},
"400": {
description: "There Was an Error creating the parcel delivery order"
}
}
}
},
"/parcels": {
get: {
tags: ["Parcels"],
summary: "Get parcel delivery orders",
consumes: ["application/x-www-form-urlencoded"],
parameters: [
{
name: "Bearer",
in: "header",
description: "Authorization token",
required: true,
type: "string"
}
]
}
},
"/parcels/:id": {
get: {
tags: ["Parcels"],
summary: "Get a parcel by it's identity number",
consumes: ["application/x-www-form-urlencoded"],
parameters: [
{
name: "Bearer",
in: "header",
description: "Authorization token",
required: true,
type: "string"
},
{
name: "ID",
in: "formData",
description: "Parcel identity number",
required: true,
type: "string"
}
]
}
},
"/parcels/:id/cancel": {
get: {
tags: ["Parcels"],
summary: "Cancel a parcel delivery order",
consumes: ["application/x-www-form-urlencoded"],
parameters: [
{
name: "Bearer",
in: "header",
description: "Authorization token",
required: true,
type: "string"
}
]
}
},
"/parcels/:id/destination": {
get: {
tags: ["Parcels"],
summary: "Change a parcel delivery order's destination",
consumes: ["application/x-www-form-urlencoded"],
parameters: [
{
name: "Bearer",
in: "header",
description: "Authorization token",
required: true,
type: "string"
},
{
name: "toAddress",
in: "formData",
description: "Parcel's new destination",
required: true,
type: "string"
}
]
}
},
"/parcels/:id/currentlocation": {
get: {
tags: ["Parcels"],
summary: "Change a parcel delivery order's current location",
consumes: ["application/x-www-form-urlencoded"],
parameters: [
{
name: "Bearer",
in: "header",
description: "Authorization token",
required: true,
type: "string"
},
{
name: "toAddress",
in: "formData",
description: "Parcel's new destination",
required: true,
type: "string"
}
]
}
},
}
};