-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
147 lines (140 loc) · 3.19 KB
/
swagger.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
openapi: 3.0.0
info:
title: Transaction API
version: 1.0.0
paths:
/transactions:
post:
summary: Ingest a transaction
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SalesEvent'
- $ref: '#/components/schemas/TaxPaymentEvent'
responses:
'202':
description: Transaction ingested successfully
'400':
description: Invalid payload
'500':
description: Internal server error
/tax-position:
get:
summary: Get tax position
parameters:
- in: query
name: date
required: true
schema:
type: string
format: date-time
description: The date up to which the tax position is calculated (ISO 8601 format)
responses:
'200':
description: Tax position calculated successfully
content:
application/json:
schema:
type: object
properties:
date:
type: string
format: date-time
taxPosition:
type: number
'400':
description: Invalid date parameter
'500':
description: Internal server error
/sale:
patch:
summary: Amend a sale
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SaleAmendment'
responses:
'202':
description: Sale amended successfully
'400':
description: Invalid amendment payload
'500':
description: Internal server error
/generate-test-data:
post:
summary: Generate test data
responses:
'201':
description: Test data generated successfully
'500':
description: Internal server error
components:
schemas:
TaxPaymentEvent:
type: object
properties:
eventType:
type: string
date:
type: string
format: date-time
amount:
type: number
required:
- eventType
- date
- amount
SaleAmendment:
type: object
properties:
date:
type: string
format: date-time
invoiceId:
type: string
itemId:
type: string
cost:
type: number
taxRate:
type: number
required:
- eventType
- date
- invoiceId
- items
SalesEvent:
type: object
properties:
eventType:
type: string
date:
type: string
format: date-time
invoiceId:
type: string
items:
$ref: '#/components/schemas/Item'
required:
- eventType
- date
- invoiceId
- items
Item:
type: object
properties:
itemId:
type: string
cost:
type: number
taxRate:
type: number
required:
- itemId
- cost
- taxRate