-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yml
167 lines (161 loc) · 4.65 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
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: 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
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: 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
/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
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: string
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