⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Add descriptions to PostageBatchShort, Bucket, and PinCheck schemas #768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
crtahlin wants to merge 1 commit into from
+19 −0
Closed

Add descriptions to PostageBatchShort, Bucket, and PinCheck schemas #768

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions openapi/SwarmCommon.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,22 +544,31 @@ components:
type: object
properties:
batchID:
description: Unique identifier of the postage batch.
$ref: "#/components/schemas/BatchID"
value:
description: Normalised balance of the batch per chunk (in PLUR). Decreases over time as storage rent is consumed.
$ref: "#/components/schemas/BigInt"
start:
description: Block number on Gnosis Chain at which the batch was created.
type: integer
depth:
description: Batch depth which determines the maximum number of chunks the batch can stamp. The theoretical maximum is 2^depth chunks, but effective capacity is lower due to how chunks are distributed across buckets.
type: integer
bucketDepth:
description: Depth of the postage batch buckets. Fixed at 16, partitioning the address space into 2^16 (65536) equally sized buckets.
type: integer
immutableFlag:
description: Whether the batch is immutable. Immutable batches permanently store data and do not allow overwriting older chunks. Mutable batches allow overwriting older data as new chunks are added.
type: boolean
batchTTL:
description: Estimated remaining time-to-live of the batch in seconds.
type: integer
owner:
description: Ethereum address of the batch owner.
$ref: "#/components/schemas/EthereumAddress"
storageRadius:
description: The storage radius of the node. Defines the proximity order of chunks for which the node is responsible for storing.
type: integer

DebugPostageBatch:
Expand All @@ -571,20 +580,26 @@ components:
type: object
properties:
bucketID:
description: Index of the bucket in the address space partition (0 to 2^bucketDepth - 1).
type: integer
collisions:
description: Number of chunks assigned to this bucket. When this reaches 2^(depth - bucketDepth), the bucket is full.
type: integer

PostageStampBuckets:
type: object
properties:
depth:
description: Batch depth of the postage batch.
type: integer
bucketDepth:
description: Depth of the postage batch buckets. Fixed at 16.
type: integer
bucketUpperBound:
description: Maximum number of chunks allowed per bucket, equal to 2^(depth - bucketDepth).
type: integer
buckets:
description: Array of bucket data showing the utilization of each bucket.
type: array
nullable: false
items:
Expand Down Expand Up @@ -665,12 +680,16 @@ components:
type: object
properties:
reference:
description: Swarm reference of the pinned root hash that was checked.
$ref: "#/components/schemas/SwarmOnlyReference"
total:
description: Total number of chunks expected for this pinned content.
type: integer
missing:
description: Number of chunks that are missing from the local store.
type: integer
invalid:
description: Number of chunks that are present but have invalid data.
type: integer

SwarmOnlyReferencesList:
Expand Down