-
Notifications
You must be signed in to change notification settings - Fork 1
/
OpenApi.yaml
296 lines (296 loc) · 8.24 KB
/
OpenApi.yaml
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
openapi: 3.0.0
servers:
- url: 'https://localhost:8081/server/services/rest'
description: Flutter Employee App Example
info:
title: devonfw Example
description: Example of a API definition
version: 1.0.0
x-rootpackage: com.devonfw.poc.jwtsample
paths:
/employeemanagement/v1/employee/{id}:
delete:
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
minimum: 0
maximum: 50
responses:
'200':
description: Any
'404':
description: Not found
tags:
- deleteEmployee
get:
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
minimum: 0
maximum: 50
responses:
'200':
description: Any
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeDetailResponseDtoSchema'
text/plain:
schema:
type: string
'404':
description: Not found
tags:
- getEmployee
/employeemanagement/v1/employee/search/:
post:
responses:
'200':
description: Any
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeListResponseDtoSchema'
'404':
description: Not found
requestBody:
$ref: '#/components/requestBodies/EmployeeListRequestDtoBody'
tags:
- searchCriteria
/employeemanagement/v1/employee/:
post:
responses:
'200':
description: Any
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeInsertResponseDtoSchema'
'404':
description: Not found
requestBody:
$ref: '#/components/requestBodies/EmployeeInsertRequestDtoBody'
tags:
- insertEmployee
components:
schemas:
PageableSortDtoSchema:
x-component: employeemanagement
description: Entity definition of PageSort
type: object
properties:
property:
type: string
maxLength: 100
minLength: 3
direction:
type: string
maxLength: 100
minLength: 3
required:
- property
- direction
PageableDtoSchema:
x-component: employeemanagement
description: Entity definition of Pageable
type: object
properties:
pageSize:
type: integer
format: int64
uniqueItems: true
pageNumber:
type: integer
format: int64
uniqueItems: true
sort:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/PageableSortDtoSchema'
required:
- property
- direction
EmployeeListRequestDtoSchema:
x-component: employeemanagement
description: Entity definiton of Employee
type: object
properties:
employeeId:
type: string
maxLength: 30
minLength: 3
uniqueItems: true
name:
type: string
maxLength: 30
minLength: 3
uniqueItems: true
surname :
type: string
maxLength: 100
minLength: 3
uniqueItems: true
email:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
pageable:
type: object
uniqueItems: true
items:
$ref: '#/components/schemas/PageableDtoSchema'
required:
- employeeId
EmployeeListResponseDtoSchema:
x-component: employeemanagement
description: Entity definiton of Employee
type: object
properties:
content:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/EmployeeListContentResponseDtoSchema'
pageable:
type: object
uniqueItems: true
items:
$ref: '#/components/schemas/PageableDtoSchema'
totalElements:
type: integer
format: int64
uniqueItems: true
EmployeeInsertResponseDtoSchema:
x-component: employeemanagement
description: Entity definiton of Employee
type: object
properties:
modificationCounter:
type: integer
format: int64
uniqueItems: true
id:
type: integer
format: int64
uniqueItems: true
name:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
surname:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
email:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
EmployeeListContentResponseDtoSchema:
x-component: employeemanagement
description: Entity definiton of Employee
type: object
properties:
modificationCounter:
type: integer
format: int64
uniqueItems: true
id:
type: integer
format: int64
uniqueItems: true
employeeId:
type: integer
format: int64
uniqueItems: true
name:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
surname:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
email:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
EmployeeInsertRequestDtoSchema:
x-component: employeemanagement
description: Entity definiton of Employee
type: object
properties:
name:
type: string
maxLength: 30
minLength: 3
uniqueItems: true
surname :
type: string
maxLength: 100
minLength: 3
uniqueItems: true
email:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
EmployeeDetailResponseDtoSchema:
x-component: employeemanagement
description: Entity definiton of Employee
type: object
properties:
modificationCounter:
type: integer
format: int64
uniqueItems: true
id:
type: integer
format: int64
uniqueItems: true
employeeId:
type: integer
format: int64
uniqueItems: true
name:
type: string
maxLength: 30
minLength: 3
uniqueItems: true
surname :
type: string
maxLength: 100
minLength: 3
uniqueItems: true
email:
type: string
maxLength: 100
minLength: 3
uniqueItems: true
requestBodies:
EmployeeListRequestDtoBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeListRequestDtoSchema'
required: true
EmployeeInsertRequestDtoBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeInsertRequestDtoSchema'