Skip to content

Commit 79ed175

Browse files
McXDMcXD
committed
added open api definition
1 parent 62a27d5 commit 79ed175

1 file changed

Lines changed: 185 additions & 0 deletions

File tree

‎Accounts/supplychain/openapi.yml‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
openapi: '3.0.2'
2+
info:
3+
title: Supplychain API
4+
version: '1.0'
5+
servers:
6+
- url: https://localhost:8080
7+
paths:
8+
/api/createAcct:
9+
post:
10+
requestBody:
11+
$ref: '#/components/schemas/Account'
12+
responses:
13+
'200':
14+
$ref: '#/components/schemas/Status'
15+
/api/shareAcct:
16+
post:
17+
requestBody:
18+
$ref: '#/components/schemas/AccountShare'
19+
responses:
20+
'200':
21+
$ref: '#/components/schemas/Status'
22+
/api/sendInternalMessage:
23+
post:
24+
requestBody:
25+
$ref: '#/components/schemas/InternalMessage'
26+
responses:
27+
'200':
28+
$ref: '#/components/schemas/Status'
29+
/api/snedPayment:
30+
post:
31+
requestBody:
32+
$ref: '#/components/schemas/Payment'
33+
responses:
34+
'200':
35+
$ref: '#/components/schemas/Status'
36+
/api/sendShippingRequest:
37+
post:
38+
requestBody:
39+
$ref: '#/components/schemas/ShippingRequest'
40+
responses:
41+
'200':
42+
$ref: '#/components/schemas/Status'
43+
/api/sendCargo:
44+
post:
45+
requestBody:
46+
$ref: '#/components/schemas/Cargo'
47+
responses:
48+
'200':
49+
$ref: '#/components/schemas/Status'
50+
/api/inbox:
51+
get:
52+
parameters:
53+
- in: query
54+
name: node
55+
schema:
56+
type: string
57+
description: node the account resides on
58+
- in: query
59+
name: acctName
60+
schema:
61+
type: string
62+
description: the account name
63+
responses:
64+
'200':
65+
$ref: '#/components/schemas/Inbox'
66+
components:
67+
schemas:
68+
Account:
69+
type: object
70+
required:
71+
- acctName
72+
- onNode
73+
properties:
74+
acctName:
75+
type: string
76+
onNode:
77+
type: string
78+
AccountShare:
79+
type: object
80+
required:
81+
- senderNode
82+
- receiverNode
83+
- acctName
84+
properties:
85+
senderNode:
86+
type: string
87+
receiverNode:
88+
type: string
89+
acctName:
90+
type: string
91+
Invoice:
92+
type: object
93+
required:
94+
- whoAmI
95+
- whereTo
96+
- amount
97+
properties:
98+
whoAmI:
99+
type: string
100+
whereTo:
101+
type: string
102+
amuont:
103+
type: integer
104+
format: int32
105+
InternalMessage:
106+
type: object
107+
required:
108+
- onNode
109+
- whoAmI
110+
- whereTo
111+
- message
112+
properties:
113+
onNode:
114+
type: string
115+
whoAmI:
116+
type: string
117+
whereTo:
118+
type: string
119+
message:
120+
type: string
121+
Payment:
122+
type: object
123+
required:
124+
- whoAmI
125+
- whereTo
126+
- amount
127+
properties:
128+
whoAmI:
129+
type: string
130+
whereTo:
131+
type: string
132+
amuont:
133+
type: integer
134+
format: int32
135+
ShippingRequest:
136+
type: object
137+
required:
138+
- whoAmI
139+
- whereTo
140+
- cargo
141+
properties:
142+
whoAmI:
143+
type: string
144+
whereTo:
145+
type: string
146+
cargo:
147+
type: string
148+
Cargo:
149+
type: object
150+
required:
151+
- pickUpFrom
152+
- whereTo
153+
- cargo
154+
properties:
155+
pickUpFrom:
156+
type: string
157+
whereTo:
158+
type: string
159+
cargo:
160+
type: string
161+
Inbox:
162+
type: object
163+
required:
164+
- fromNode
165+
- ofAcct
166+
- messages
167+
properties:
168+
fromNode:
169+
type: string
170+
ofAcct:
171+
type: string
172+
messages:
173+
type: array
174+
items:
175+
type: string
176+
Status:
177+
type: object
178+
required:
179+
- success
180+
properties:
181+
success:
182+
type: boolean
183+
184+
185+

0 commit comments

Comments
 (0)