-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi.yaml
382 lines (382 loc) · 11.3 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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
openapi: 3.0.2
info:
title: Payments API
description: A description of simple payments REST API.
version: 0.0.1
servers:
- url: 'http://localhost:8080/'
paths:
/payments:
get:
summary: Retrieve collection of payments.
operationId: findPayments
parameters:
- name: 'filter[id]'
description: Retrieve only payments having the specified id.
in: query
required: false
schema:
type: string
- name: 'filter[debtor.account_number]'
description: Retrieve only payments made from a specified account number.
in: query
required: false
schema:
type: string
- name: 'filter[creditor.account_number]'
description: Retrieve only payments made to a specified account number.
in: query
required: false
schema:
type: string
- name: 'page[number]'
description: 'Retrieve only specified page.'
in: query
required: false
schema:
type: integer
minimum: 1
- name: 'page[size]'
description: 'Retrieve only specified number of items on a page.'
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 500
responses:
'200':
description: Successfuly retrieved payment collection.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PaymentCollectionResponse'
'400':
description: Invalid query parameters.
content:
application/vnd.api+json:
schema:
type: array
items:
$ref: '#/components/schemas/Error'
post:
summary: Create a new payment.
operationId: createPayment
requestBody:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PaymentCreateRequest'
responses:
'201':
description: New payment successfully created.
content:
application/vnd+api+json:
schema:
$ref: '#/components/schemas/PaymentCreateResponse'
'400':
description: Unable to create payment due to invalid input.
content:
application/vnd+api+json:
schema:
type: array
items:
$ref: '#/components/schemas/Error'
'409':
description: Unable to create payment due to resource attributes conflict.
content:
application/vnd+api+json:
schema:
type: array
items:
$ref: '#/components/schemas/Error'
/payments/{payment_id}:
get:
summary: Retrieve an existing payment.
operationId: getPaymentById
parameters:
- name: payment_id
in: path
description: Unique payment identifier.
required: true
schema:
$ref: '#/components/schemas/ID'
responses:
'200':
description: Payment successfully retrieved.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PaymentGetResponse'
'404':
description: Payment not found.
content:
application/vnd.api+json:
schema:
type: array
items:
$ref: '#/components/schemas/Error'
patch:
summary: Edit an existing payment.
operationId: editPayment
parameters:
- name: payment_id
in: path
description: Unique payment identifier.
required: true
schema:
$ref: '#/components/schemas/ID'
requestBody:
required: true
content:
application/vnd+api+json:
schema:
$ref: '#/components/schemas/PaymentEditRequest'
responses:
'200':
description: Payment successfully edited.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PaymentEditResponse'
'404':
description: Payment not found.
content:
application/vnd.api+json:
schema:
type: array
items:
$ref: '#/components/schemas/Error'
delete:
summary: Delete an existing payment.
operationId: deletePayment
parameters:
- name: payment_id
in: path
description: Unique payment identifier.
required: true
schema:
$ref: '#/components/schemas/ID'
responses:
'204':
description: An existing payment successfully deleted.
components:
schemas:
Error:
description: An API error.
type: object
required: [status, code, title]
properties:
status:
type: string
description: HTTP status code.
code:
type: string
description: An application-specific error code.
title:
type: string
description: A human-readable summary of the problem.
detail:
description: A human-readable explanation of the problem.
type: object
ID:
description: Globally unique identifier of a resource. in form of UUIDv4.
type: string
format: uuid
CurrencyCode:
description: Currency code as defined in [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
type: string
Monetary:
description: Represents a monetary amount.
type: object
properties:
value:
type: string
pattern: '^(0|[1-9]\d*)(\.\d{2})?$'
currency:
$ref: '#/components/schemas/CurrencyCode'
Address:
type: object
properties:
line1:
type: string
line2:
type: string
city:
type: string
region:
type: string
postal_code:
type: string
country_code:
description: ISO 3166 format country code.
type: string
PaymentScheme:
type: string
enum: [SWIFT, SEPA]
PaymentParty:
type: object
properties:
name:
description: Name of the payment party.
type: string
account_name:
description: Name of beneficiary as given with account
type: string
account_number:
description: Beneficiary account number
type: string
account_provider:
$ref: '#/components/schemas/AccountProvider'
address:
$ref: '#/components/schemas/Address'
AccountProvider:
type: object
properties:
code:
description: Account provider code.
type: string
name:
description: Human-redable name of the account provider.
type: string
PaymentCollectionResponse:
description: Payment collection.
type: object
required: [data]
properties:
data:
type: object
required: [id, type, attributes]
properties:
id:
$ref: '#/components/schemas/ID'
type:
type: string
enum: [payments]
attributes:
type: object
properties:
amount:
$ref: '#/components/schemas/Monetary'
debtor:
$ref: '#/components/schemas/PaymentParty'
creditor:
$ref: '#/components/schemas/PaymentParty'
scheme:
$ref: '#/components/schemas/PaymentScheme'
links:
type: object
description: Pagination links.
properties:
first:
description: Link to the first page.
type: string
last:
description: Link to the last page.
type: string
next:
description: Link to the next page.
type: string
prev:
description: Link to the previous page.
type: string
PaymentCreateRequest:
description: Payment resource.
type: object
required: [data]
properties:
data:
type: object
required: [id, type, attributes]
properties:
id:
$ref: '#/components/schemas/ID'
type:
type: string
enum: [payments]
attributes:
required: [amount, debtor, creditor, scheme]
properties:
amount:
allOf:
- $ref: '#/components/schemas/Monetary'
required: [value, currency]
debtor:
allOf:
- $ref: '#/components/schemas/PaymentParty'
required: [account_number]
creditor:
allOf:
- $ref: '#/components/schemas/PaymentParty'
required: [account_number]
scheme:
$ref: '#/components/schemas/PaymentScheme'
PaymentCreateResponse:
description: Payment resource.
type: object
properties:
data:
type: object
properties:
id:
$ref: '#/components/schemas/ID'
type:
type: string
enum: [payments]
attributes:
properties:
amount:
$ref: '#/components/schemas/Monetary'
debtor:
$ref: '#/components/schemas/PaymentParty'
creditor:
$ref: '#/components/schemas/PaymentParty'
scheme:
$ref: '#/components/schemas/PaymentScheme'
PaymentGetResponse:
type: object
PaymentEditRequest:
type: object
properties:
data:
type: object
required: [id, type, attributes]
properties:
id:
$ref: '#/components/schemas/ID'
type:
type: string
enum: [payments]
attributes:
properties:
amount:
$ref: '#/components/schemas/Monetary'
debtor:
$ref: '#/components/schemas/PaymentParty'
creditor:
$ref: '#/components/schemas/PaymentParty'
scheme:
$ref: '#/components/schemas/PaymentScheme'
PaymentEditResponse:
description: Payment resource.
type: object
properties:
data:
type: object
properties:
id:
$ref: '#/components/schemas/ID'
type:
type: string
enum: [payments]
attributes:
properties:
amount:
$ref: '#/components/schemas/Monetary'
debtor:
$ref: '#/components/schemas/PaymentParty'
creditor:
$ref: '#/components/schemas/PaymentParty'
scheme:
$ref: '#/components/schemas/PaymentScheme'