Skip to content

Commit 03d5b28

Browse files
committed
Update OpenAPI spec
1 parent 9fb020d commit 03d5b28

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

openapi.yaml

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -365,12 +365,12 @@ paths:
365365
summary: Records snapshot download event
366366
description: Records snapshot download event
367367
requestBody:
368-
description: Downloaded snapshot
368+
description: Downloaded snapshot message
369369
required: true
370370
content:
371371
application/json:
372372
schema:
373-
$ref: "#/components/schemas/SnapshotMessage"
373+
$ref: "#/components/schemas/SnapshotDownloadMessage"
374374
responses:
375375
"201":
376376
description: Event successfully recorded
@@ -1148,6 +1148,60 @@ components:
11481148
"cardano_node_version": "1.0.0"
11491149
}
11501150

1151+
SnapshotDownloadMessage:
1152+
description: SnapshotDownloadMessage represents a downloaded snapshot event
1153+
type: object
1154+
additionalProperties: false
1155+
required:
1156+
- digest
1157+
- beacon
1158+
- size
1159+
- locations
1160+
- compression_algorithm
1161+
- cardano_node_version
1162+
properties:
1163+
digest:
1164+
description: Digest that is signed by the signer participants
1165+
type: string
1166+
format: bytes
1167+
beacon:
1168+
$ref: "#/components/schemas/Beacon"
1169+
size:
1170+
description: Size of the snapshot file in Bytes
1171+
type: integer
1172+
format: int64
1173+
locations:
1174+
description: Locations where the binary content of the snapshot can be retrieved
1175+
type: array
1176+
items:
1177+
type: string
1178+
compression_algorithm:
1179+
description: Compression algorithm for the snapshot archive
1180+
type: string
1181+
cardano_node_version:
1182+
description: Version of the Cardano node which is used to create snapshot archives.
1183+
type: string
1184+
example:
1185+
{
1186+
"digest": "6367ee65d0d1272e6e70736a1ea2cae34015874517f6328364f6b73930966732",
1187+
"beacon":
1188+
{
1189+
"network": "mainnet",
1190+
"epoch": 329,
1191+
"immutable_file_number": 7060000
1192+
},
1193+
"size": 26058531636,
1194+
"locations":
1195+
[
1196+
"https://mithril-cdn-us.iohk.io/snapshot/6367ee65d0d1272e6e70736a1ea2cae34015874517f6328364f6b73930966732",
1197+
"https://mithril-cdn-eu.iohk.io/snapshot/6367ee65d0d1272e6e70736a1ea2cae34015874517f6328364f6b73930966732",
1198+
"magnet:?xt=urn:sha1:YNCKHTQCWBTRNJIV4WNAE52SJUQCZO5C",
1199+
"ipfs:QmPXME1oRtoT627YKaDPDQ3PwA8tdP9rWuAAweLzqSwAWT"
1200+
],
1201+
"compression_algorithm": "zstandard",
1202+
"cardano_node_version": "1.0.0"
1203+
}
1204+
11511205
MithrilStakeDistributionListMessage:
11521206
description: MithrilStakeDistributionListMessage represents a list of Mithril stake distribution
11531207
type: array

0 commit comments

Comments
 (0)