-
Notifications
You must be signed in to change notification settings - Fork 17
/
api
290 lines (289 loc) · 12.9 KB
/
api
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
#%RAML 0.8
title: "OrientSmpp"
version: "1.0.0"
baseUri: "https://orientsolutions.co.tz:443/api"
schemas:
-
"User": '{"type":"object","title":"User","properties":{"id":{"type":"integer","required":false,"title":"id"},"lastName":{"type":"string","required":false,"title":"lastName"},"userlogin":{"type":"string","required":false,"title":"userlogin"},"phone":{"type":"string","required":false,"title":"phone"},"email":{"type":"string","required":false,"title":"email"},"userStatus":{"type":"integer","required":false,"title":"userStatus"},"firstName":{"type":"string","required":false,"title":"firstName"},"password":{"type":"string","required":false,"title":"password"}}}'
"Category": '{"type":"object","title":"Category","properties":{"id":{"type":"integer","required":false,"title":"id"},"name":{"type":"string","required":false,"title":"name"}}}'
"Pet": '{"type":"object","title":"Pet","properties":{"tags":{"type":"array","required":false,"title":"tags","items":{"type":"object","$ref":"#/schemas/Tag"},"uniqueItems":false},"id":{"type":"integer","required":true,"title":"id"},"category":{"type":"object","$ref":"#/schemas/Category","required":false,"title":"category"},"status":{"type":"string","required":false,"title":"status"},"name":{"type":"string","required":true,"title":"name"},"photoUrls":{"type":"array","required":false,"title":"photoUrls","items":{"type":"string","title":"photoUrls"},"uniqueItems":false}}}'
"Tag": '{"type":"object","title":"Tag","properties":{"id":{"type":"integer","required":false,"title":"id"},"name":{"type":"string","required":false,"title":"name"}}}'
"File": '{"type":"object","title":"File"}'
"Order": '{"type":"object","title":"Order","properties":{"id":{"type":"integer","required":false,"title":"id"},"petId":{"type":"integer","required":false,"title":"petId"},"status":{"type":"string","required":false,"title":"status"},"quantity":{"type":"integer","required":false,"title":"quantity"},"shipDate":{"type":"string","required":false,"title":"shipDate"}}}'
securitySchemes:
-
"/user/createWithList":
displayName: "CreateUsersWithList"
post:
description: "Creates list of users with given list input"
body:
"application/json":
schema: "User"
example: '[{"id":1,"lastName":"sample lastName","userlogin":"sample userlogin","phone":"sample phone","email":"sample email","userStatus":1,"firstName":"sample firstName","password":"sample password"}]'
responses:
"200":
description: "Success"
"/pet":
displayName: "PetList"
post:
description: "Add a new pet to the store"
body:
"application/xml":
schema: "Pet"
example: "<Pet><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></Pet>"
"text/xml":
schema: "Pet"
example: "<Pet><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></Pet>"
"application/json":
schema: "Pet"
example: '{"tags":[],"id":1,"category":null,"status":"sample status","name":"sample name","photoUrls":["sample photoUrls"]}'
responses:
"405":
"200":
description: "Success"
put:
description: "Update an existing pet"
body:
"application/xml":
schema: "Pet"
example: "<Pet><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></Pet>"
"text/xml":
schema: "Pet"
example: "<Pet><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></Pet>"
"application/json":
schema: "Pet"
example: '{"tags":[],"id":1,"category":null,"status":"sample status","name":"sample name","photoUrls":["sample photoUrls"]}'
responses:
"405":
"404":
"200":
description: "Success"
"400":
"/store/order/{orderId}":
displayName: "StoreOrder"
uriParameters:
"orderId":
displayName: "orderId"
description: "ID of the order that needs to be deleted"
type: string
required: false
repeat: false
get:
description: "Find purchase order by ID"
responses:
"404":
body:
"application/json":
example: ""
"200":
description: "Success"
body:
"application/json":
schema: "Order"
example: '{"id":1,"petId":1,"status":"sample status","quantity":1,"shipDate":"sample shipDate"}'
"400":
body:
"application/json":
example: ""
delete:
description: "Delete purchase order by ID"
responses:
"404":
"200":
description: "Success"
"400":
"/user/createWithArray":
displayName: "CreateUsersWithArray"
post:
description: "Creates list of users with given input array"
body:
"application/json":
schema: "User"
example: '[{"id":1,"lastName":"sample lastName","userlogin":"sample userlogin","phone":"sample phone","email":"sample email","userStatus":1,"firstName":"sample firstName","password":"sample password"}]'
responses:
"200":
description: "Success"
"/user/{userlogin}":
displayName: "User"
uriParameters:
"userlogin":
displayName: "userlogin"
description: "name that need to be deleted"
type: string
required: false
repeat: false
get:
description: "Get user by user name"
responses:
"404":
body:
"application/json":
example: ""
"200":
description: "Success"
body:
"application/json":
schema: "User"
example: '{"id":1,"lastName":"sample lastName","userlogin":"sample userlogin","phone":"sample phone","email":"sample email","userStatus":1,"firstName":"sample firstName","password":"sample password"}'
"400":
body:
"application/json":
example: ""
delete:
description: "Delete user"
responses:
"404":
"200":
description: "Success"
"400":
put:
description: "Updated user"
body:
"application/json":
schema: "User"
example: '{"id":1,"lastName":"sample lastName","userlogin":"sample userlogin","phone":"sample phone","email":"sample email","userStatus":1,"firstName":"sample firstName","password":"sample password"}'
responses:
"404":
"200":
description: "Success"
"400":
"/store/order":
displayName: "StoreOrderList"
post:
description: "Place an order for a pet"
body:
"application/json":
schema: "Order"
example: '{"id":1,"petId":1,"status":"sample status","quantity":1,"shipDate":"sample shipDate"}'
responses:
"200":
description: "Success"
"400":
"/pet/findByStatus":
displayName: "FindPetByStatus"
get:
description: "Finds Pets by status"
queryParameters:
"status":
displayName: "status"
description: "Status values that need to be considered for filter"
type: string
required: true
repeat: true
default: "available"
responses:
"200":
description: "Success"
body:
"application/xml":
schema: "Pet"
example: "<ArrayList><item><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></item></ArrayList>"
"text/xml":
schema: "Pet"
example: "<ArrayList><item><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></item></ArrayList>"
"application/json":
schema: "Pet"
example: '[{"tags":[],"id":1,"category":null,"status":"sample status","name":"sample name","photoUrls":["sample photoUrls"]}]'
"400":
body:
"application/xml":
example: ""
"text/xml":
example: ""
"application/json":
example: ""
"/pet/findByTags":
displayName: "FindPetByTags"
get:
description: "Finds Pets by tags"
queryParameters:
"tags":
displayName: "tags"
description: "Tags to filter by"
type: string
required: true
repeat: true
responses:
"200":
description: "Success"
body:
"application/xml":
schema: "Pet"
example: "<ArrayList><item><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></item></ArrayList>"
"text/xml":
schema: "Pet"
example: "<ArrayList><item><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></item></ArrayList>"
"application/json":
schema: "Pet"
example: '[{"tags":[],"id":1,"category":null,"status":"sample status","name":"sample name","photoUrls":["sample photoUrls"]}]'
"400":
body:
"application/xml":
example: ""
"text/xml":
example: ""
"application/json":
example: ""
"/user":
displayName: "UserList"
post:
description: "Create user"
body:
"application/json":
schema: "User"
example: '{"id":1,"lastName":"sample lastName","userlogin":"sample userlogin","phone":"sample phone","email":"sample email","userStatus":1,"firstName":"sample firstName","password":"sample password"}'
responses:
"200":
description: "Success"
"/pet/{petId}":
displayName: "Pet"
uriParameters:
"petId":
displayName: "petId"
description: "ID of pet that needs to be fetched"
type: number
required: false
repeat: false
get:
description: "Find pet by ID"
responses:
"404":
body:
"application/xml":
example: ""
"text/xml":
example: ""
"application/json":
example: ""
"200":
description: "Success"
body:
"application/xml":
schema: "Pet"
example: "<Pet><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></Pet>"
"text/xml":
schema: "Pet"
example: "<Pet><id>1</id><category/><status>sample status</status><name>sample name</name><photoUrls>sample photoUrls</photoUrls></Pet>"
"application/json":
schema: "Pet"
example: '{"tags":[],"id":1,"category":null,"status":"sample status","name":"sample name","photoUrls":["sample photoUrls"]}'
"400":
body:
"application/xml":
example: ""
"text/xml":
example: ""
"application/json":
example: ""
post:
description: "Updates a pet in the store with form data"
responses:
"405":
"200":
description: "Success"
delete:
description: "Deletes a pet"
responses:
"200":
description: "Success"
"400":