-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.json
160 lines (160 loc) · 3.49 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
{
"swagger": "2.0",
"info": {
"description": "API Documentation for use",
"version": "1.0.0",
"title": "Docu API",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"email": "[email protected]"
},
"license": {
"name": "MIT",
"url": "https://opensource.org/licenses/MIT"
}
},
"host": "localhost:8080",
"basePath": "/",
"tags": [
{
"name": "users",
"description": "user administration in the app"
}
],
"schemes": [
"https",
"http"
],
"paths": {
"/users/register": {
"post": {
"tags": [
"users"
],
"summary": "Add a new user",
"description": "",
"operationId": "addUser",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "User object that needs to be added to the store",
"required": true,
"schema": {
"$ref": "#/definitions/Users"
}
}
],
"responses": {
"200": {
"description": "user created"
},
"400": {
"description": "user email exists"
}
}
}
},
"/users/{id}": {
"put": {
"tags": [
"users"
],
"summary": "Updated user",
"description": "This can only be done by the logged in user.",
"operationId": "updateUser",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id that need to be updated",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "Updated user object",
"required": true,
"schema": {
"$ref": "#/definitions/Users"
}
}
],
"responses": {
"200": {
"description": "User updated"
},
"400": {
"description": "Invalid user supplied"
},
"404": {
"description": "User not found"
}
}
},
"delete": {
"tags": [
"users"
],
"summary": "Delete user",
"description": "This can only be done by the logged in user.",
"operationId": "deleteUser",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The name that needs to be deleted",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "User deleted"
},
"400": {
"description": "Invalid username supplied"
},
"404": {
"description": "User not found"
}
}
}
}
},
"definitions": {
"Users": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
}
},
"xml": {
"name": "Users"
}
}
}
}