-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yml
381 lines (369 loc) · 11.4 KB
/
swagger.yml
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
swagger: "2.0"
info:
description: This is the swagger file that goes with our server code
version: "1.0.0"
title: Swagger Rest Article
consumes:
- application/json
produces:
- application/json
basePath: /api
# Paths supported by the server application
paths:
/people:
get:
operationId: people.read_all
tags:
- People
summary: Read the entire set of people, sorted by last name
description: Read the entire set of people, sorted by last name
responses:
200:
description: Successfully read people set operation
schema:
type: array
items:
properties:
person_id:
type: integer
description: Id of the person
fname:
type: string
description: First name of the person
lname:
type: string
description: Last name of the person
timestamp:
type: string
description: Create/Update timestamp of the person
notes:
type: array
items:
properties:
person_id:
type: integer
description: Id of person this note is associated with
note_id:
type: integer
description: Id of this note
content:
type: string
description: content of this note
timestamp:
type: string
description: Create/Update timestamp of this note
post:
operationId: people.create
tags:
- People
summary: Create a person
description: Create a new person
parameters:
- name: person
in: body
description: Person to create
required: True
schema:
type: object
properties:
fname:
type: string
description: First name of person to create
lname:
type: string
description: Last name of person to create
responses:
201:
description: Successfully created person
schema:
properties:
person_id:
type: integer
description: Id of the person
fname:
type: string
description: First name of the person
lname:
type: string
description: Last name of the person
timestamp:
type: string
description: Creation/Update timestamp of the person record
/people/{person_id}:
get:
operationId: people.read_one
tags:
- People
summary: Read one person
description: Read one person
parameters:
- name: person_id
in: path
description: Id of the person to get
type: integer
required: True
responses:
200:
description: Successfully read person from people data operation
schema:
type: object
properties:
person_id:
type: string
description: Id of the person
fname:
type: string
description: First name of the person
lname:
type: string
description: Last name of the person
timestamp:
type: string
description: Creation/Update timestamp of the person record
notes:
type: array
items:
properties:
person_id:
type: integer
description: Id of person this note is associated with
note_id:
type: integer
description: Id of this note
content:
type: string
description: content of this note
timestamp:
type: string
description: Create/Update timestamp of this note
put:
operationId: people.update
tags:
- People
summary: Update a person
description: Update a person
parameters:
- name: person_id
in: path
description: Id the person to update
type: integer
required: True
- name: person
in: body
schema:
type: object
properties:
fname:
type: string
description: First name of the person
lname:
type: string
description: Last name of the person
responses:
200:
description: Successfully updated person
schema:
properties:
person_id:
type: integer
description: Id of the person in the database
fname:
type: string
description: First name of the person
lname:
type: string
description: Last name of the person
timestamp:
type: string
description: Creation/Update timestamp of the person record
delete:
operationId: people.delete
tags:
- People
summary: Delete a person from the people list
description: Delete a person
parameters:
- name: person_id
in: path
type: integer
description: Id of the person to delete
required: true
responses:
200:
description: Successfully deleted a person
/notes:
get:
operationId: notes.read_all
tags:
- Notes
summary: Read the entire set of notes for all people, sorted by timestamp
description: Read the entire set of notes for all people, sorted by timestamp
responses:
200:
description: Successfully read notes for all people operation
schema:
type: array
items:
properties:
note_id:
type: integer
description: Id of the note
content:
type: string
description: Content of the note
timestamp:
type: string
description: Create/Update timestamp of the note
person:
type: object
properties:
person_id:
type: integer
description: Id of associated person
fname:
type: string
description: Frist name of associated person
lname:
type: string
description: Last name of associated person
timestamp:
type: string
description: Create/Update timestamp of associated person
/people/{person_id}/notes:
post:
operationId: notes.create
tags:
- Notes
summary: Create a note associated with a person
description: Create a note associated with a person
parameters:
- name: person_id
in: path
description: Id of person associated with note
type: integer
required: True
- name: note
in: body
description: Text content of the note to create
required: True
schema:
type: object
properties:
content:
type: string
description: Text of the note to create
responses:
201:
description: Successfully created a note
schema:
properties:
person_id:
type: integer
description: Id of the person associated with the note
note_id:
type: integer
description: Id of the created note
content:
type: string
description: Text content of the note
timestamp:
type: string
description: Creation/Update timestamp of the person record
/people/{person_id}/notes/{note_id}:
get:
operationId: notes.read_one
tags:
- Notes
summary: Read a particular note associated with a person
description: Read a particular note associated with a person
parameters:
- name: person_id
in: path
description: Id of person associated with note
type: integer
required: True
- name: note_id
in: path
description: Id of note
type: integer
required: True
responses:
200:
description: Successfully read note for a person
schema:
type: object
properties:
note_id:
type: integer
description: Id of the note
person_id:
type: integer
description: Id of the person note associated with
content:
type: string
description: Text content of the note
timestamp:
type: string
description: Creation/Update timestamp of the note record
put:
operationId: notes.update
tags:
- Notes
summary: Update a note associated with a person
description: Update a note associated with a person
parameters:
- name: person_id
in: path
description: Id the person to update
type: integer
required: True
- name: note_id
in: path
description: Id of the note associated with a person
type: integer
required: True
- name: note
in: body
schema:
type: object
properties:
content:
type: string
description: Text content of the note to updated
responses:
200:
description: Successfully updated note
schema:
properties:
note_id:
type: string
description: Id of the note associated with a person
person_id:
type: integer
description: Id of the person in the database
content:
type: string
description: Text content of the updated note
timestamp:
type: string
description: Creation/Update timestamp of the note record
delete:
operationId: notes.delete
tags:
- Notes
summary: Delete a note associated with a person
description: Delete a note associated with a person
parameters:
- name: person_id
in: path
description: Id of person associated with note
type: integer
required: True
- name: note_id
in: path
description: Id of note
type: integer
required: True
responses:
200:
description: Successfully deleted a note