-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yml
130 lines (127 loc) · 3.53 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
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 list of people"
description: "Read the list of people"
parameters:
- name: length # Numerical length of the people data
in: query
type: integer
description: Number of people to get from people
required: false
- name: offset # ???
in: query
type: integer
description: Offset from beginning of list where to start gathering people
responses:
200:
description: "Successful read people list operation"
schema:
type: "array"
items:
properties:
fname:
type: "string"
lname:
type: "string"
timestamp:
type: "string"
post:
operationId: people.create
tags:
- People
summary: Create a person and add it to the people list
description: Create a new person in the people list
parameters:
- name: person
in: body
description: Person to create
required: True
schema:
type: object #why only object here and put method
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 in list
/people/{lname}:
get:
operationId: people.read_one
tags:
- People
summary: Read one person from the people list
description: Read one person from the people list
parameters:
- name: lname
in: path
description: Last name of the person to get from the list
type: string
required: True
responses:
200:
description: Successfully read person from people list operation
schema:
properties:
fname:
type: string
lname:
type: string
timestring:
type: string
put:
operationId: people.update
tags:
- People
summary: Update a person in the people list
description: Update a person in the people list
parameters:
- name: lname
in: path
description: Last name of the person to update in the list
type: string
required: True
- name: person
in: body
schema:
type: object
properties:
fname:
type: string
lname:
type: string
responses:
200:
description: Successfully updated person in people list
delete:
operationId: people.delete
tags:
- People
summary: Delete a person from the people list
description: Delete a person
parameters:
- name: lname
in: path
type: string
required: True
responses:
200:
description: Successfully deleted a person from people list