-
Notifications
You must be signed in to change notification settings - Fork 1
/
api-specification.yaml
431 lines (412 loc) · 10.4 KB
/
api-specification.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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
openapi: 3.0.1
info:
title: Hyperledger Fabric API
description: API for managing assets in Hyperledger Fabric
version: 1.0.0
servers:
- url: http://localhost:3000
paths:
/api/assets:
post:
summary: Create a new asset
requestBody:
description: Asset
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
responses:
'201':
description: Asset created successfully
/api/assets/{AssetId}:
get:
summary: Retrieve an asset's information by ID
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
responses:
'200':
description: Asset retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
put:
summary: Update an existing asset
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
requestBody:
description: Updated asset details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
responses:
'200':
description: Asset updated successfully
delete:
summary: Delete an asset by ID
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
responses:
'204':
description: Asset deleted successfully
/api/assets/{AssetId}/process:
put:
summary: Update an existing asset
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
requestBody:
description: Update process details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
responses:
'200':
description: Process updated successfully
/api/assets/{AssetId}/package:
put:
summary: Update an existing asset
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
requestBody:
description: Update package details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Package'
responses:
'200':
description: Package updated successfully
/api/assets/{AssetId}/ship:
put:
summary: Update an existing asset
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
requestBody:
description: Update shipping details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Ship'
responses:
'200':
description: Process updated successfully
/api/assets/{AssetId}/complete:
put:
summary: Update an existing asset
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
requestBody:
description: Update shipping details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CompleteShipment'
responses:
'200':
description: Process updated successfully
/api/assets/{AssetId}/exists:
get:
summary: Check if an asset exists by ID
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
responses:
'200':
description: Asset existence checked successfully
content:
application/json:
schema:
type: object
properties:
exists:
type: boolean
/api/assets/{AssetId}/transfer:
post:
summary: Transfer ownership of an asset
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
requestBody:
description: New owner details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Transfer'
responses:
'200':
description: Asset transferred successfully
/api/assets/all:
get:
summary: Get all assets in the ledger
responses:
'200':
description: Assets retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Transfer'
/api/assets/{AssetId}/history:
get:
summary: Get the history of a specific asset
parameters:
- in: path
name: AssetId
required: true
schema:
type: string
responses:
'200':
description: Asset history retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TransactionHistory'
/api/owners/{OwnerId}/assets:
get:
summary: Get all assets owned by a specific entity
parameters:
- in: path
name: OwnerId
required: true
schema:
type: string
responses:
'200':
description: Assets retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Asset'
components:
schemas:
Asset:
type: object
properties:
ItemID:
type: string
ItemName:
type: string
Origin:
type: object
properties:
Farm:
type: string
OriginLocation:
type: string
Certifications:
type: array
items:
type: string
HarvestDate:
type: string
format: date
Processing:
type: object
properties:
Processor:
type: string
ProcessingLocation:
type: string
ProcessDate:
type: string
format: date-time
ProcessType:
type: string
Packaging:
type: object
properties:
Packager:
type: string
PackagingLocation:
type: string
PackageDate:
type: string
format: date
PackageType:
type: string
Shipment:
type: object
properties:
Shipper:
type: string
ShipmentID:
type: string
Origin:
type: string
Destination:
type: string
DepartureDate:
type: string
format: date
ArrivalDate:
type: string
format: date
Status:
type: string
CurrentOwner:
type: object
properties:
Entity:
type: string
OwnerLocation:
type: string
ReceivedDate:
type: string
format: date
TransactionHistory:
type: array
items:
type: object
properties:
TransactionID:
type: string
Timestamp:
type: string
format: date-time
From:
type: string
To:
type: string
Details:
type: string
Transfer:
type: object
properties:
NewOwner:
type: object
properties:
Entity:
type: string
OwnerLocation:
type: string
ReceivedDate:
type: string
format: date
TransferTransaction:
type: object
properties:
TransactionID:
type: string
Details:
type: string
TransactionHistory:
type: array
items:
type: object
properties:
TransactionID:
type: string
Timestamp:
type: string
format: date-time
From:
type: string
To:
type: string
Details:
type: string
Process:
type: object
properties:
Processor:
type: string
ProcessingLocation:
type: string
ProcessDate:
type: string
format: date-time
ProcessType:
type: string
TransactionID:
type: string
Package:
type: object
properties:
Packager:
type: string
PackagingLocation:
type: string
PackageDate:
type: string
format: date
PackageType:
type: string
TransactionID:
type: string
Ship:
type: object
properties:
Shipper:
type: string
ShipmentID:
type: string
Destination:
type: string
DepartureDate:
type: string
format: date
Status:
type: string
TransactionID:
type: string
CompleteShipment:
type: object
properties:
Recipient:
type: string
ArrivalDate:
type: string
format: date
Status:
type: string
TransactionID:
type: string