Repository navigation
Expand file tree
/
Copy pathapi-definition.yaml
More file actions
248 lines (241 loc) · 6.95 KB
/
Copy pathapi-definition.yaml
File metadata and controls
248 lines (241 loc) · 6.95 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
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
openapi: "3.0.0"
info:
version: 0.0.1
title: Person Service API
paths:
/v1/ping/pong:
post:
summary: Checks to see if the API GW and Lambda is up.
requestBody:
content:
application/json:
schema:
type: object
properties:
control:
type: object
data:
type: object
example:
control: {}
data: {}
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
control:
type: object
properties:
ResponseCode:
type: number
TraceID:
type: string
data:
type: string
example:
control:
ResponseCode: 2000
TraceID: "f1a8207b-a1e5-4ef4-8425-9ecaa7e1a457"
data: "Pong"
/v1/client/create:
post:
summary: Creates a client
requestBody:
content:
application/json:
schema:
type: object
properties:
control:
type: object
data:
type: object
properties:
name:
type: string
example:
control: {}
data:
name: "AWESOME CLIENT"
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
control:
type: object
properties:
ResponseCode:
type: number
TraceID:
type: string
data:
$ref: "#/components/schemas/Client"
example:
control:
ResponseCode: 2000
TraceID: "f3a04797-8d56-4604-ad10-933feccf7015"
data:
client_id: "94a72d65-b27e-4a84-be46-1bdc237f7a8f"
name: "AWESOME CLIENT"
person_count: 0
created_at: "2020-06-25 17:59:10.961"
/v1/client/find_first:
post:
summary: Finds the first X amount of clients
requestBody:
content:
application/json:
schema:
type: object
properties:
control:
type: object
data:
type: object
properties:
limit:
type: number
example:
control: {}
data:
limit: 100
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
control:
type: object
properties:
ResponseCode:
type: number
TraceID:
type: string
data:
type: object
properties:
Items:
type: array
items:
$ref: "#/components/schemas/Client"
example:
control:
ResponseCode: 2000
TraceID: "f3a04797-8d56-4604-ad10-933feccf7015"
data:
- client_id: "94a72d65-b27e-4a84-be46-1bdc237f7a8f"
name: "AWESOME CLIENT"
person_count: 0
created_at: "2020-06-25 17:59:10.961"
/v1/client/find:
post:
summary: Finds a specific client
requestBody:
content:
application/json:
schema:
type: object
properties:
control:
type: object
data:
type: object
properties:
client_id:
type: string
example:
control: {}
data:
client_id: "94a72d65-b27e-4a84-be46-1bdc237f7a8f"
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
control:
type: object
properties:
ResponseCode:
type: number
TraceID:
type: string
data:
$ref: "#/components/schemas/Client"
example:
control:
ResponseCode: 2000
TraceID: "f3a04797-8d56-4604-ad10-933feccf7015"
data:
client_id: "94a72d65-b27e-4a84-be46-1bdc237f7a8f"
name: "AWESOME CLIENT"
person_count: 0
created_at: "2020-06-25 17:59:10.961"
/v1/client/increment_person_count:
post:
summary: Increments the person count for a specific client
requestBody:
content:
application/json:
schema:
type: object
properties:
control:
type: object
data:
type: object
properties:
client_id:
type: string
example:
control: {}
data:
client_id: "94a72d65-b27e-4a84-be46-1bdc237f7a8f"
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
control:
type: object
properties:
ResponseCode:
type: number
TraceID:
type: string
data:
type: boolean
example:
control:
ResponseCode: 2000
TraceID: "f3a04797-8d56-4604-ad10-933feccf7015"
data: true
components:
schemas:
Client:
type: object
properties:
client_id:
type: string
name:
type: string
person_count:
type: number
created_at:
type: string