-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.json
142 lines (142 loc) · 3.89 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
{
"swagger" : "2.0",
"info" : {
"description" : "This is a simple API",
"version" : "1.0.0",
"title" : "Simple Inventory API123",
"contact" : {
"email" : "you@your-company.com"
},
"license" : {
"name" : "Apache 2.0",
"url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"tags" : [ {
"name" : "admins",
"description" : "Secured Admin-only calls"
}, {
"name" : "developers",
"description" : "Operations available to regular developers"
} ],
"schemes" : [ "https" ],
"paths" : {
"/inventory" : {
"get" : {
"tags" : [ "developers" ],
"summary" : "searches inventory",
"operationId" : "searchInventory",
"description" : "By passing in the appropriate options, you can search for\navailable inventory in the system\n",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "query",
"name" : "searchString",
"description" : "pass an optional search string for looking up inventory",
"required" : false,
"type" : "string"
}, {
"in" : "query",
"name" : "skip",
"description" : "number of records to skip for pagination",
"type" : "integer",
"format" : "int32",
"minimum" : 0
}, {
"in" : "query",
"name" : "limit",
"description" : "maximum number of records to return",
"type" : "integer",
"format" : "int32",
"minimum" : 0,
"maximum" : 50
} ],
"responses" : {
"200" : {
"description" : "search results matching criteria",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/InventoryItem"
}
}
},
"400" : {
"description" : "bad input parameter"
}
}
},
"post" : {
"tags" : [ "admins" ],
"summary" : "adds an inventory item",
"operationId" : "addInventory",
"description" : "Adds an item to the system",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "inventoryItem",
"description" : "Inventory item to add",
"schema" : {
"$ref" : "#/definitions/InventoryItem"
}
} ],
"responses" : {
"201" : {
"description" : "item created"
},
"400" : {
"description" : "invalid input, object invalid"
},
"409" : {
"description" : "an existing item already exists"
}
}
}
}
},
"definitions" : {
"InventoryItem" : {
"type" : "object",
"required" : [ "id", "name", "manufacturer", "releaseDate" ],
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid",
"example" : "d290f1ee-6c54-4b01-90e6-d701748f0851"
},
"name" : {
"type" : "string",
"example" : "Widget Adapter"
},
"releaseDate" : {
"type" : "string",
"format" : "int32",
"example" : "2016-08-29T09:12:33.001Z"
},
"manufacturer" : {
"$ref" : "#/definitions/Manufacturer"
}
}
},
"Manufacturer" : {
"required" : [ "name" ],
"properties" : {
"name" : {
"type" : "string",
"example" : "ACME Corporation"
},
"homePage" : {
"type" : "string",
"format" : "url",
"example" : "https://www.acme-corp.com"
},
"phone" : {
"type" : "string",
"example" : "408-867-5309"
}
}
}
},
"host" : "virtserver.swaggerhub.com",
"basePath" : "/pavel-sos/test2/1.0.0"
}