Skip to content

Commit

Permalink
docs(objectarium): document bucket statistics type and new query field
Browse files Browse the repository at this point in the history
  • Loading branch information
@ccamel
ccamel committed Jun 11, 2024
1 parent 0f45e53 commit d58259d
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/axone-objectarium.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,10 @@ BucketResponse is the response of the Bucket query.
| `pagination` | _(Required.) _ **[PaginationConfig](#paginationconfig)**. The configuration for paginated query. |
| `pagination.default_page_size` | **integer**. The default number of elements in a page.<br /><br />Shall be less or equal than `max_page_size`. Default to '10' if not set.<br />**Default:** `10` |
| `pagination.max_page_size` | **integer**. The maximum elements a page can contain.<br /><br />Shall be less than `u32::MAX - 1`. Default to '30' if not set.<br />**Default:** `30` |
| `stat` | _(Required.) _ **[BucketStat](#bucketstat)**. The statistics of the bucket. |
| `stat.compressed_size` | **[Uint128](#uint128)**. The total size of the objects contained in the bucket after compression. |
| `stat.object_count` | **[Uint128](#uint128)**. The number of objects in the bucket. |
| `stat.size` | **[Uint128](#uint128)**. The total size of the objects contained in the bucket. |

### object

Expand Down Expand Up @@ -356,6 +360,16 @@ The limits are optional and if not set, there is no limit.
| `max_objects` | **[Uint128](#uint128)\|null**. The maximum number of objects in the bucket. |
| `max_total_size` | **[Uint128](#uint128)\|null**. The maximum total size of the objects in the bucket. |

### BucketStat

BucketStat is the type of the statistics of a bucket.

| property | description |
| ----------------- | ---------------------------------------------------------------------------------------------------------------- |
| `compressed_size` | _(Required.) _ **[Uint128](#uint128)**. The total size of the objects contained in the bucket after compression. |
| `object_count` | _(Required.) _ **[Uint128](#uint128)**. The number of objects in the bucket. |
| `size` | _(Required.) _ **[Uint128](#uint128)**. The total size of the objects contained in the bucket. |

### CompressionAlgorithm

CompressionAlgorithm is an enumeration that defines the different compression algorithms supported for compressing the content of objects. The compression algorithm specified here are relevant algorithms for compressing data on-chain, which means that they are fast to compress and decompress, and have a low computational cost.
Expand Down Expand Up @@ -511,4 +525,4 @@ A string containing a 128-bit integer in decimal representation.

---

_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-objectarium.json` (`7767f03132c85cdd`)_
_Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-objectarium.json` (`3a727fbaea0f27bc`)_

0 comments on commit d58259d

Please sign in to comment.