-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswagger.api.specs.yml
More file actions
219 lines (218 loc) · 8.47 KB
/
swagger.api.specs.yml
File metadata and controls
219 lines (218 loc) · 8.47 KB
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
openapi: 3.0.0
info:
title: Courier Sample API
description: Couriers Rest API Test specs
version: 1.0.0
servers:
- url: http://localhost:3001/api/v1
description: Development environment
paths:
/health-checks/alive:
get:
summary: Checks whether the API services are up and ready
tags:
- Health checks
responses:
"200":
description: A health check object
content:
application/json:
schema:
type: object
properties:
uptime:
type: integer
example: 797.071158636
message:
type: string
example: Ok
date:
type: string
example: "2024-01-30T18:37:06.234Z"
/couriers:
get:
summary: Returns a collection of users.
tags:
- Couriers
responses:
"200":
description: A JSON collection of couriers
content:
application/json:
schema:
type: array
items:
properties:
_id:
type: string
example: 65b941ecb897374b7aa89f7d
max_capacity:
type: integer
example: 100
post:
summary: Create a courier.
tags:
- Couriers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
max_capacity:
type: integer
example: 100
responses:
"201":
description: Courier has been created
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 65b941ecb897374b7aa89f7d
max_capacity:
type: integer
example: 100
/couriers/{courierId}:
get:
summary: Returns a courier by ID.
tags:
- Couriers
parameters:
- name: courierId
in: path
required: true
schema:
type: string
responses:
"200":
description: A courier representation
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 65b941ecb897374b7aa89f7d
max_capacity:
type: integer
example: 100
"404":
description: Courier not found
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
message:
type: string
example: Custom error message
put:
summary: Update a courier by ID.
tags:
- Couriers
parameters:
- name: courierId
in: path
required: true
schema:
type: string
requestBody:
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
max_capacity:
type: integer
example: 100
responses:
"200":
description: A courier representation
content:
application/json:
schema:
type: object
properties:
_id:
type: string
example: 65b941ecb897374b7aa89f7d
max_capacity:
type: integer
example: 100
"404":
description: Courier not found
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
message:
type: string
example: Custom error message
delete:
summary: Delete a courier by ID.
tags:
- Couriers
parameters:
- name: courierId
in: path
required: true
schema:
type: string
responses:
"200":
description: Courier has been deleted
"404":
description: Courier not found
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
message:
type: string
example: Custom error message
/couriers/lookup/{capacityRequired}:
get:
summary: Returns a collection of users that match a capacity criteria greater or equals than requested.
tags:
- Courier actions
parameters:
- name: capacityRequired
in: path
required: true
schema:
type: integer
min: 0
responses:
"200":
description: A JSON collection of couriers
content:
application/json:
schema:
type: array
items:
properties:
_id:
type: string
example: 65b941ecb897374b7aa89f7d
max_capacity:
type: integer
example: 100