-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml.teplsql
307 lines (296 loc) · 7.87 KB
/
swagger.yaml.teplsql
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<%@ template name=swagger %>
<%! col swaggerGen.column_tt := swaggerGen.get_all_columns ('${table_name}'); %>
<%! pk swaggerGen.column_tt := swaggerGen.get_pk_columns ('${table_name}', '${unque_key}'); %>
<%! c pls_integer; %>
<%! procedure sep (p_cont in pls_integer, p_delimiter in varchar2)
as
begin
if p_cont > 1
then
teplsql.p(p_delimiter);
end if;
end;
%>
swagger: '2.0'
info:
title: REST API for ${table_name}
description: API for all CRUD operations of the table ${table_name}
version: 1.0.0
host: '127.0.0.1:8080'
basePath: /api/v1
schemes:
- http
produces:
- application/json
tags:
- name: "${lower_table_name}"
description: "Table description"
paths:
'/${lower_table_name}':
get:
tags:
- ${lower_table_name}
summary: "Get all rows"
produces:
- application/json
parameters:
- $ref: "#/parameters/offsetParam"
- $ref: "#/parameters/limitParam"
- $ref: "#/parameters/sortParam"
<% for i in 1 .. col.last loop %>
- $ref: "#/parameters/<%=col(i).column_name%>FilterParam"
<% end loop;%>
responses:
200:
description: Success
schema:
$ref: "#/definitions/${className}List"
400:
$ref: '#/responses/400BadRequest'
404:
$ref: '#/responses/404NotFound'
500:
$ref: '#/responses/500InternalServerError'
post:
tags:
- ${lower_table_name}
summary: "Add a new row"
produces:
- application/json
parameters:
- $ref: "#/parameters/payloadParam"
responses:
201:
description: Success
schema:
$ref: "#/definitions/${className}Object"
400:
$ref: '#/responses/400BadRequest'
404:
$ref: '#/responses/404NotFound'
500:
$ref: '#/responses/500InternalServerError'
'/${lower_table_name}/{<%= pk(1).column_name %>}':
get:
tags:
- ${lower_table_name}
summary: "Get a single row"
produces:
- application/json
parameters:
- $ref: "#/parameters/idParam"
responses:
200:
description: Success
schema:
$ref: "#/definitions/${className}Object"
400:
$ref: '#/responses/400BadRequest'
404:
$ref: '#/responses/404NotFound'
500:
$ref: '#/responses/500InternalServerError'
put:
tags:
- ${lower_table_name}
summary: "Updates all fields in a row"
produces:
- application/json
parameters:
- $ref: "#/parameters/idParam"
- $ref: "#/parameters/payloadParam"
responses:
204:
description: Success
400:
$ref: '#/responses/400BadRequest'
404:
$ref: '#/responses/404NotFound'
500:
$ref: '#/responses/500InternalServerError'
patch:
tags:
- ${lower_table_name}
summary: "Partial update of a row"
operationId: updateItem
parameters:
- $ref: "#/parameters/idParam"
- $ref: "#/parameters/payloadParam"
responses:
204:
description: Success
400:
$ref: '#/responses/400BadRequest'
404:
$ref: '#/responses/404NotFound'
500:
$ref: '#/responses/500InternalServerError'
delete:
tags:
- ${lower_table_name}
summary: "Delete an existin row"
produces:
- application/json
parameters:
- $ref: "#/parameters/idParam"
responses:
204:
description: Success
400:
$ref: '#/responses/400BadRequest'
404:
$ref: '#/responses/404NotFound'
500:
$ref: '#/responses/500InternalServerError'
definitions:
${className}:
properties:
<% for i in 1 .. col.last loop %>
<%= col(i).COLUMN_NAME%>:
type: "<%= col(i).data_type %>"
<% if col(i).data_format is not null then %>
format: "<%= col(i).data_format%>"
<% end if; %><% end loop; %>
${className}List:
properties:
data:
type: "array"
items:
$ref: '#/definitions/${className}'
pagination:
$ref: '#/definitions/Pagination'
${className}Object:
properties:
data:
$ref: '#/definitions/${className}'
Pagination:
properties:
offset:
type: integer
limit:
type: integer
total:
type: integer
Message:
type: object
properties:
message:
type: string
Error:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
field:
type: string
Errors:
type: array
items:
$ref: '#/definitions/Error'
ValidationError:
type: object
properties:
message:
type: string
errors:
$ref: '#/definitions/Errors'
parameters:
idParam:
name: <%= pk(1).column_name %>\\n
in: path
required: true
type: <%= pk(1).data_type %>\\n
description: implicit
pattern: '^[^/]+$'
payloadParam:
name: payload
in: body
required: true
schema:
$ref: '#/definitions/${className}Object'
offsetParam:
name: offset
in: query
required: false
description: The number of rows to skip before starting to collect the result set.
type: integer
format: int32
minimum: 0
default: 0
limitParam:
name: limit
in: query
required: false
description: The number of rows to return.
type: integer
format: int32
default: 20
minimum: 10
maximum: 100
sortParam:
name: sort
in: query
type: array
required: false
description: Sorting order of rows
uniqueItems: true
minItems: 1
maxItems: 6
collectionFormat: pipes
items:
type: string
pattern: '[-+](<% c := col.last+1; for i in 1 .. col.last loop %><%= col(i).COLUMN_NAME %><%sep(c-i,'|'); end loop;%>)'
default: '+<%= pk(1).column_name %>\\n'
<% for i in 1 .. col.last loop %>
<%=col(i).column_name%>FilterParam:
name: <%=col(i).column_name%>\\n
in: query
required: false
description: The <%=col(i).column_name%> column value to filter results.
type: <%= col(i).data_type %>\\n
<% if col(i).data_format is not null then %>
format: "<%= col(i).data_format%>"
<% end if; end loop; %>
responses:
SuccessMessage:
description: Success
schema:
$ref: '#/definitions/Message'
400BadRequest:
description: The request was invalid or cannot be otherwise served.
schema:
$ref: '#/definitions/ValidationError'
401Unauthorized:
description: Authentication credentials were missing or incorrect.
schema:
$ref: '#/definitions/Message'
403Forbidden:
description: The request is understood, but it has been refused or access is not allowed.
schema:
$ref: '#/definitions/Message'
404NotFound:
description: The URI requested is invalid or the resource requested does not exists.
schema:
$ref: '#/definitions/Message'
409Conflict:
description: Any message which should help the user to resolve the conflict.
schema:
$ref: '#/definitions/Message'
429TooManyRequests:
description: The request cannot be served due to the application’s rate limit having been exhausted for the resource.
schema:
$ref: '#/definitions/Message'
500InternalServerError:
description: Something is broken.
schema:
$ref: '#/definitions/Message'
503ServiceUnavailable:
description: The server is up, but overloaded with requests. Try again later.
schema:
$ref: '#/definitions/Message'
externalDocs:
description: "Swagger doc generated with Osalvador Code Generator"
url: "https://apex.oracle.com/pls/apex/f?p=48301:1:33118650103837:::::"