This repository has been archived by the owner on Apr 11, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathswagger.json
199 lines (199 loc) · 4.44 KB
/
swagger.json
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
{
"swagger": "2.0",
"info": {
"title": "Person API",
"description": "API for Managing People",
"version": "1.0.0"
},
"produces": ["application/json"],
"host": "localhost:3000",
"basePath": "/",
"tags": [
{
"name": "person",
"description": "Person"
}
],
"paths": {
"/person": {
"get": {
"tags": [
"person"
],
"x-swagger-router-controller": "person",
"operationId": "GET",
"description": "Returns a list of persons",
"responses": {
"200": {
"description": "Person list",
"schema": {
"$ref": "#/definitions/Person"
}
},
"default": {
"description": "Unexpected error",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
},
"post": {
"tags": [
"person"
],
"x-swagger-router-controller": "person",
"operationId": "POST",
"description": "Create person",
"parameters": [
{
"name": "body",
"in": "body",
"description": "The person details",
"required": true,
"schema": {
"$ref": "#/definitions/Person"
}
}
],
"responses": {
"201": {
"description": "Newly created person",
"schema": {
"$ref": "#/definitions/Person"
}
},
"default": {
"description": "Unexpected error",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
}
},
"/person/{id}": {
"get": {
"tags": [
"person"
],
"x-swagger-router-controller": "person",
"operationId": "GET",
"description": "Fetch a person",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The person ID to fetch",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Person details",
"schema": {
"$ref": "#/definitions/Person"
}
},
"default": {
"description": "Unexpected error",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
},
"put": {
"tags": [
"person"
],
"x-swagger-router-controller": "person",
"operationId": "PUT",
"description": "Update a person",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The person ID to update",
"required": true,
"type": "integer"
},
{
"name": "body",
"in": "body",
"description": "The person details for the update",
"required": true,
"schema": {
"$ref": "#/definitions/Person"
}
}
],
"responses": {
"200": {
"description": "Updated person details",
"schema": {
"$ref": "#/definitions/Person"
}
},
"default": {
"description": "Unexpected error",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
}
}
},
"definitions": {
"Error": {
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
},
"Success": {
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
},
"Person": {
"required": ["name"],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"finance",
"accounts",
"sales",
"leads"
]
},
"uniqueItems": true
}
}
}
}
}