-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAPI-Specification.yml
240 lines (240 loc) · 6.57 KB
/
API-Specification.yml
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
---
openapi: 3.0.1
info:
title: StockTrading.API
version: "1.0"
paths:
"/api/Company":
get:
tags:
- Company
summary: Get all companies
responses:
"200":
description: Success
content:
text/plain:
schema:
type: array
items:
"$ref": "#/components/schemas/Company"
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Company"
text/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Company"
"/api/Company/{companySymbol}/shares":
post:
tags:
- Company
summary: Issue shares for a company
parameters:
- name: companySymbol
in: path
description: The company to issue shares for
required: true
schema:
type: string
description: The company to issue shares for
nullable: true
requestBody:
description: The payload containing how many shares and at what price to issue
content:
application/json:
schema:
"$ref": "#/components/schemas/IssueSharesRequest"
text/json:
schema:
"$ref": "#/components/schemas/IssueSharesRequest"
application/*+json:
schema:
"$ref": "#/components/schemas/IssueSharesRequest"
responses:
"200":
description: Success
content:
text/plain:
schema:
"$ref": "#/components/schemas/Order"
application/json:
schema:
"$ref": "#/components/schemas/Order"
text/json:
schema:
"$ref": "#/components/schemas/Order"
"/api/Order":
get:
tags:
- Order
summary: Get all outstanding (not processed) orders
responses:
"200":
description: Success
content:
text/plain:
schema:
type: array
items:
"$ref": "#/components/schemas/Order"
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Order"
text/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Order"
post:
tags:
- Order
summary: Create a new order
requestBody:
description: The payload containing information about the order to create
content:
application/json:
schema:
"$ref": "#/components/schemas/CreateOrderRequest"
text/json:
schema:
"$ref": "#/components/schemas/CreateOrderRequest"
application/*+json:
schema:
"$ref": "#/components/schemas/CreateOrderRequest"
responses:
"200":
description: Success
content:
text/plain:
schema:
"$ref": "#/components/schemas/Order"
application/json:
schema:
"$ref": "#/components/schemas/Order"
text/json:
schema:
"$ref": "#/components/schemas/Order"
"/api/Order/{orderId}":
get:
tags:
- Order
summary: Get information about a specific order
parameters:
- name: orderId
in: path
description: The order ID to look up
required: true
schema:
type: string
description: The order ID to look up
format: uuid
responses:
"200":
description: Success
content:
text/plain:
schema:
"$ref": "#/components/schemas/Order"
application/json:
schema:
"$ref": "#/components/schemas/Order"
text/json:
schema:
"$ref": "#/components/schemas/Order"
components:
schemas:
Company:
type: object
properties:
symbol:
type: string
nullable: true
readOnly: true
additionalProperties: false
IssueSharesRequest:
type: object
properties:
quantity:
type: integer
description: The number of shares to issue
format: int32
price:
type: number
description: The price which the shares will cost
format: double
additionalProperties: false
description: The payload containing how many shares and at what price to issue
OrderType:
enum:
- Buy
- Sell
type: string
OrderStatus:
enum:
- Processing
- Processed
type: string
Order:
type: object
properties:
id:
type: string
format: uuid
readOnly: true
created:
type: string
format: date-time
readOnly: true
companySymbol:
type: string
nullable: true
readOnly: true
minOrderPrice:
type: number
format: double
readOnly: true
maxOrderPrice:
type: number
format: double
readOnly: true
quantity:
type: integer
format: int32
readOnly: true
quantityRemaining:
type: integer
format: int32
orderType:
"$ref": "#/components/schemas/OrderType"
orderStatus:
"$ref": "#/components/schemas/OrderStatus"
additionalProperties: false
CreateOrderRequest:
type: object
properties:
symbol:
type: string
description: The symbol representing the company that the order is for
nullable: true
minOrderPrice:
type: number
description: The minimum price that the order should be considered for
format: double
maxOrderPrice:
type: number
description: The maximum price that the order should be considered for
format: double
quantity:
type: integer
description: The number of shares to place the order for
format: int32
orderType:
"$ref": "#/components/schemas/OrderType"
additionalProperties: false
description: The payload containing information about the order to create