-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger-example.json
219 lines (219 loc) · 7.61 KB
/
swagger-example.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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
{
"basePath": "/example/api/v1",
"paths": {
"/type/{id}": {
"post": {
"description": "This method is not allowed.",
"operationId": "posttype{id}",
"responses": {"405": {"description": "Method not allowed"}},
"parameters": [{
"in": "path",
"name": "id",
"format": "long",
"type": "number",
"required": true
}],
"tags": [
"type",
"type{id}"
]
},
"get": {
"produces": [
"application/json;charset=utf-8",
"application/atom+xml"
],
"description": "Returns the type with the specific id",
"operationId": "gettype{id}",
"responses": {
"200": {
"schema": {"$ref": "#/definitions/Type"},
"description": "Type entity found"
},
"500": {"description": "An error occured while request"},
"404": {"description": "Type entity not found"}
},
"parameters": [{
"in": "path",
"name": "id",
"format": "long",
"type": "number",
"required": true
}],
"tags": [
"type",
"type{id}"
]
},
"delete": {
"description": "Deletes the type with the specific id",
"operationId": "deletetype{id}",
"responses": {
"200": {"description": "Type entity deleted successfully"},
"500": {"description": "An error occured while delete"}
},
"parameters": [{
"in": "path",
"name": "id",
"format": "long",
"type": "number",
"required": true
}],
"tags": [
"type",
"type{id}"
]
},
"put": {
"produces": ["application/json"],
"description": "Updates the Type with the specific id",
"operationId": "puttype{id}",
"responses": {
"200": {
"schema": {
"type": "array",
"items": {"$ref": "#/definitions/Type"}
},
"description": "Type entity updated successfully"
},
"500": {"description": "An error occured while update"}
},
"parameters": [
{
"schema": {"$ref": "#/definitions/Type"},
"in": "body",
"name": "type",
"description": "Type description ",
"required": true
},
{
"in": "query",
"name": "test",
"format": "long",
"description": "test query parameter ",
"type": "number"
},
{
"in": "path",
"name": "id",
"format": "long",
"type": "number",
"required": true
}
],
"consumes": ["application/json"],
"tags": [
"type",
"type{id}"
]
}
},
"/types": {
"post": {
"produces": ["application/json"],
"description": "Creates a new type",
"operationId": "posttypes",
"responses": {
"201": {
"schema": {"$ref": "#/definitions/Type"},
"description": "Type entity created successfully"
},
"400": {"description": "An error occurred while validation"}
},
"parameters": [{
"schema": {"$ref": "#/definitions/Type"},
"in": "body",
"name": "type",
"description": "Type entity ",
"required": true
}],
"consumes": ["application/json"],
"tags": ["types"]
},
"get": {
"produces": ["application/json"],
"description": "",
"operationId": "gettypes",
"responses": {
"200": {
"schema": {
"type": "array",
"items": {"$ref": "#/definitions/Type"}
},
"description": "Type entities found"
},
"500": {"description": "An error occured while request"}
},
"parameters": [
{
"in": "query",
"name": "name",
"description": "name of type or null ",
"type": "string"
},
{
"in": "query",
"name": "createdAt",
"description": "creation date range or null ",
"type": "string"
}
],
"tags": ["types"]
},
"delete": {
"description": "This method is not allowed. When requesting the HTTP status 405 will return",
"operationId": "deletetypes",
"responses": {"405": {"description": "Method not allowed"}},
"tags": ["types"]
},
"put": {
"description": "This method is not allowed. When requesting the HTTP status 405 will return",
"operationId": "puttypes",
"responses": {"405": {"description": "Method not allowed"}},
"tags": ["types"]
}
}
},
"host": "localhost:8080",
"definitions": {"Type": {
"type": "object",
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"codes": {
"type": "array",
"items": {
"format": "long",
"type": "number"
}
},
"byteString": {
"format": "byte",
"type": "string"
},
"bool": {"type": "boolean"},
"name": {"type": "string"},
"id": {
"format": "long",
"type": "number"
},
"something": {
"type": "array",
"items": {"type": "string"}
}
}
}},
"swagger": "2.0",
"info": {
"description": "Not existing API for demonstrating the javadoc2swagger-maven-plugin",
"title": "Example API",
"version": "0.0.1-SNAPSHOT"
},
"tags": [
{"name": "type"},
{"name": "type{id}"},
{"name": "types"}
]
}