-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathFromStoryToOASForMDSLWebsite-Target.yaml
250 lines (250 loc) · 8.64 KB
/
FromStoryToOASForMDSLWebsite-Target.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
openapi: 3.0.1
info:
title: SoadDemo
version: "1.0"
servers:
- url: http://localhost:8080
tags:
- name: SampleIntegrationScenarioRealizationEndpointProvider-Home
externalDocs:
description: The role of this endpoint, offering a SampleIntegrationScenarioRealizationEndpoint
contract, is Information Holder Resource pattern
url: https://microservice-api-patterns.org/patterns/responsibility/endpointRoles/InformationHolderResource.html
- name: SampleIntegrationScenarioRealizationEndpointProvider-Home_deleteSomeBusinessObject
externalDocs:
description: The role of this endpoint, offering a SampleIntegrationScenarioRealizationEndpoint
contract, is Information Holder Resource pattern
url: https://microservice-api-patterns.org/patterns/responsibility/endpointRoles/InformationHolderResource.html
- name: SampleIntegrationScenarioRealizationEndpointProvider-Resource2
externalDocs:
description: The role of this endpoint, offering a SampleIntegrationScenarioRealizationEndpoint
contract, is Information Holder Resource pattern
url: https://microservice-api-patterns.org/patterns/responsibility/endpointRoles/InformationHolderResource.html
- name: SampleIntegrationScenarioRealizationEndpointProvider-Resource3
externalDocs:
description: The role of this endpoint, offering a SampleIntegrationScenarioRealizationEndpoint
contract, is Information Holder Resource pattern
url: https://microservice-api-patterns.org/patterns/responsibility/endpointRoles/InformationHolderResource.html
paths:
/Home:
summary: general data-oriented endpoint
get:
tags:
- SampleIntegrationScenarioRealizationEndpointProvider-Home
summary: read only
description: This operation realizes the [Retrieval Operation](https://microservice-api-patterns.org/patterns/responsibility/operationResponsibilities/RetrievalOperation.html)
pattern.
operationId: Home-readSomeBusinessObject
parameters:
- name: queryFilter
in: query
required: true
schema:
type: string
responses:
"200":
description: readSomeBusinessObject successful execution
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SomeBusinessObjectDTO'
put:
tags:
- SampleIntegrationScenarioRealizationEndpointProvider-Home
summary: write only
description: This operation realizes the [State Creation Operation](https://microservice-api-patterns.org/patterns/responsibility/operationResponsibilities/StateCreationOperation.html)
pattern.
operationId: Home-createSomeBusinessObject
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SomeBusinessObjectDTO'
responses:
"200":
description: createSomeBusinessObject successful execution
content:
application/json:
schema:
type: object
properties:
resourceId:
type: string
post:
tags:
- SampleIntegrationScenarioRealizationEndpointProvider-Home
description: unspecified operation responsibility
operationId: Home-doSomething
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
dataTransferObject:
type: string
responses:
"200":
description: doSomething successful execution
content:
application/json:
schema:
type: object
properties:
doSomethingResponseBody:
type: string
/{resourceId}:
summary: general data-oriented endpoint
delete:
tags:
- SampleIntegrationScenarioRealizationEndpointProvider-Home_deleteSomeBusinessObject
summary: ""
description: unspecified operation responsibility
operationId: Home_deleteSomeBusinessObject-deleteSomeBusinessObject
parameters:
- name: resourceId
in: path
required: true
schema:
type: string
responses:
"200":
description: deleteSomeBusinessObject successful execution
content:
application/json:
schema:
type: object
properties:
successFlag:
type: boolean
parameters:
- name: resourceId
in: path
required: true
schema:
type: string
/Resource2:
summary: general data-oriented endpoint
get:
tags:
- SampleIntegrationScenarioRealizationEndpointProvider-Resource2
summary: read only
description: This operation realizes the [Retrieval Operation](https://microservice-api-patterns.org/patterns/responsibility/operationResponsibilities/RetrievalOperation.html)
pattern.
operationId: Resource2-findAll
parameters:
- name: queryFilter
in: query
required: true
schema:
type: string
responses:
"200":
description: findAll successful execution
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SampleIntegrationScenarioRealizationEndpointDTO'
post:
tags:
- SampleIntegrationScenarioRealizationEndpointProvider-Resource2
summary: read and write
description: This operation realizes the [State Transition Operation](https://microservice-api-patterns.org/patterns/responsibility/operationResponsibilities/StateTransitionOperation.html)
pattern.
operationId: Resource2-updateSomeBusinessObject
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SomeBusinessObjectDTO'
responses:
"200":
description: updateSomeBusinessObject successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/SomeBusinessObjectDTO'
/Resource3:
summary: general data-oriented endpoint
get:
tags:
- SampleIntegrationScenarioRealizationEndpointProvider-Resource3
summary: read only
description: This operation realizes the [Retrieval Operation](https://microservice-api-patterns.org/patterns/responsibility/operationResponsibilities/RetrievalOperation.html)
pattern.
operationId: Resource3-findById
parameters:
- name: resourceId
in: query
required: true
schema:
type: string
responses:
"200":
description: findById successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/SampleIntegrationScenarioRealizationEndpointDTO'
/SampleIntegrationScenarioFlowEndpoint:
summary: activity-oriented endpoint
post:
tags:
- SampleIntegrationScenarioFlowEndpoint
summary: ""
description: unspecified operation responsibility
operationId: cRUDSomeBusinessObject
parameters: []
responses:
"200":
description: cRUDSomeBusinessObject successful execution
content:
application/json:
schema:
type: object
patch:
tags:
- SampleIntegrationScenarioFlowEndpoint
summary: read and write
description: This operation realizes the [State Transition Operation](https://microservice-api-patterns.org/patterns/responsibility/operationResponsibilities/StateTransitionOperation.html)
pattern.
operationId: doSomething
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
doSomethingRequestBody:
type: string
desiredElements:
type: array
items:
type: string
responses:
"200":
description: doSomething successful execution
content:
application/json:
schema:
type: object
components:
schemas:
SomeBusinessObjectDTO:
type: object
properties:
someBusinessObject:
type: string
SampleIntegrationScenarioRealizationEndpointDTO:
type: object
properties:
sampleIntegrationScenarioRealizationEndpoint:
type: string