Skip to content

Commit

Permalink
docs: add space after requred tag
Browse files Browse the repository at this point in the history
docusaurus still doesn't render it, though
  • Loading branch information
egasimus committed Aug 5, 2023
1 parent b881727 commit 6b1cabe
Show file tree
Hide file tree
Showing 13 changed files with 389 additions and 389 deletions.
106 changes: 53 additions & 53 deletions contracts/okp4-cognitarium.md

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions contracts/okp4-law-stone.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Instantiate message

|parameter|description|
|----------|-----------|
|`program`|*(Required.)* **[Binary](#binary)**. The Prolog program carrying law rules and facts.|
|`storage_address`|*(Required.)* **string**. The `okp4-objectarium` contract address on which to store the law program.|
|`program`|*(Required.) * **[Binary](#binary)**. The Prolog program carrying law rules and facts.|
|`storage_address`|*(Required.) * **string**. The `okp4-objectarium` contract address on which to store the law program.|

## ExecuteMsg

Expand All @@ -45,8 +45,8 @@ If not broken, ask the logic module the provided query with the law program load

|parameter|description|
|----------|-----------|
|`ask`|*(Required.)* **object**. |
|`ask.query`|*(Required.)* **string**. |
|`ask`|*(Required.) * **object**. |
|`ask.query`|*(Required.) * **string**. |

### QueryMsg::Program

Expand All @@ -65,17 +65,17 @@ If not broken, returns the law program location information.
|property|description|
|----------|-----------|
|`answer`|**[Answer](#answer)\|null**. |
|`gas_used`|*(Required.)* **integer**. |
|`height`|*(Required.)* **integer**. |
|`gas_used`|*(Required.) * **integer**. |
|`height`|*(Required.) * **integer**. |

### program

ProgramResponse carry elements to locate the program in a `okp4-objectarium` contract.

|property|description|
|----------|-----------|
|`object_id`|*(Required.)* **string**. The program object id in the `okp4-objectarium` contract.|
|`storage_address`|*(Required.)* **string**. The `okp4-objectarium` contract address on which the law program is stored.|
|`object_id`|*(Required.) * **string**. The program object id in the `okp4-objectarium` contract.|
|`storage_address`|*(Required.) * **string**. The `okp4-objectarium` contract address on which the law program is stored.|

## Definitions

Expand All @@ -85,10 +85,10 @@ ProgramResponse carry elements to locate the program in a `okp4-objectarium` con

|property|description|
|----------|-----------|
|`has_more`|*(Required.)* **boolean**. |
|`results`|*(Required.)* **Array<[Result](#result)>**. |
|`success`|*(Required.)* **boolean**. |
|`variables`|*(Required.)* **Array<string>**. |
|`has_more`|*(Required.) * **boolean**. |
|`results`|*(Required.) * **Array<[Result](#result)>**. |
|`success`|*(Required.) * **boolean**. |
|`variables`|*(Required.) * **Array<string>**. |

### Binary

Expand All @@ -104,22 +104,22 @@ A string containing Base64-encoded data.

|property|description|
|----------|-----------|
|`substitutions`|*(Required.)* **Array<[Substitution](#substitution)>**. |
|`substitutions`|*(Required.) * **Array<[Substitution](#substitution)>**. |

### Substitution



|property|description|
|----------|-----------|
|`term`|*(Required.)* **object**. |
|`variable`|*(Required.)* **string**. |
|`term`|*(Required.) * **object**. |
|`variable`|*(Required.) * **string**. |

### Term



|property|description|
|----------|-----------|
|`arguments`|*(Required.)* **Array<[Term](#term)>**. |
|`name`|*(Required.)* **string**. |
|`arguments`|*(Required.) * **Array<[Term](#term)>**. |
|`name`|*(Required.) * **string**. |
80 changes: 40 additions & 40 deletions contracts/okp4-objectarium.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Instantiate messages

|parameter|description|
|----------|-----------|
|`bucket`|*(Required.)* **string**. The name of the bucket. The name could not be empty or contains whitespaces. If name contains whitespace, they will be removed.|
|`bucket`|*(Required.) * **string**. The name of the bucket. The name could not be empty or contains whitespaces. If name contains whitespace, they will be removed.|
|`config`|**[BucketConfig](#bucketconfig)**. The configuration of the bucket.|
|`config.accepted_compression_algorithms`|**Array&lt;[CompressionAlgorithm](#compressionalgorithm)&gt;**. The acceptable compression algorithms for the objects in the bucket. If this parameter is not set (none or empty array), then all compression algorithms are accepted. If this parameter is set, then only the compression algorithms in the array are accepted.<br /><br />When an object is stored in the bucket without a specified compression algorithm, the first algorithm in the array is used. Therefore, the order of the algorithms in the array is significant. Typically, the most efficient compression algorithm, such as the NoCompression algorithm, should be placed first in the array.<br /><br />Any attempt to store an object using a different compression algorithm than the ones specified here will fail.<br />**Default:** `["passthrough","snappy","lzma"]`|
|`config.hash_algorithm`|**[HashAlgorithm](#hashalgorithm)**. The algorithm used to hash the content of the objects to generate the id of the objects. The algorithm is optional and if not set, the default algorithm is used.<br /><br />The default algorithm is Sha256 if not set.<br />**Default:** `"sha256"`|
Expand All @@ -132,37 +132,37 @@ The "compression_algorithm" parameter specifies the algorithm for compressing th

|parameter|description|
|----------|-----------|
|`store_object`|*(Required.)* **object**. |
|`store_object`|*(Required.) * **object**. |
|`store_object.compression_algorithm`|**[CompressionAlgorithm](#compressionalgorithm)\|null**. Specifies the compression algorithm to use when storing the object. If None, the first algorithm specified in the list of accepted compression algorithms of the bucket is used (see [BucketLimits::accepted_compression_algorithms]).|
|`store_object.data`|*(Required.)* **[Binary](#binary)**. The content of the object to store.|
|`store_object.pin`|*(Required.)* **boolean**. Specifies if the object should be pinned for the sender.|
|`store_object.data`|*(Required.) * **[Binary](#binary)**. The content of the object to store.|
|`store_object.pin`|*(Required.) * **boolean**. Specifies if the object should be pinned for the sender.|

### ExecuteMsg::ForgetObject

ForgetObject first unpin the object from the bucket for the considered sender, then remove it from the storage if it is not pinned anymore. If the object is pinned for other senders, it is not removed from the storage and an error is returned. If the object is not pinned for the sender, this is a no-op.

|parameter|description|
|----------|-----------|
|`forget_object`|*(Required.)* **object**. |
|`forget_object.id`|*(Required.)* **string**. |
|`forget_object`|*(Required.) * **object**. |
|`forget_object.id`|*(Required.) * **string**. |

### ExecuteMsg::PinObject

PinObject pins the object in the bucket for the considered sender. If the object is already pinned for the sender, this is a no-op. While an object is pinned, it cannot be removed from the storage.

|parameter|description|
|----------|-----------|
|`pin_object`|*(Required.)* **object**. |
|`pin_object.id`|*(Required.)* **string**. |
|`pin_object`|*(Required.) * **object**. |
|`pin_object.id`|*(Required.) * **string**. |

### ExecuteMsg::UnpinObject

UnpinObject unpins the object in the bucket for the considered sender. If the object is not pinned for the sender, this is a no-op. The object can be removed from the storage if it is not pinned anymore.

|parameter|description|
|----------|-----------|
|`unpin_object`|*(Required.)* **object**. |
|`unpin_object.id`|*(Required.)* **string**. |
|`unpin_object`|*(Required.) * **object**. |
|`unpin_object.id`|*(Required.) * **string**. |

## QueryMsg

Expand All @@ -174,24 +174,24 @@ Bucket returns the bucket information.

|parameter|description|
|----------|-----------|
|`bucket`|*(Required.)* **object**. |
|`bucket`|*(Required.) * **object**. |

### QueryMsg::Object

Object returns the object information with the given id.

|parameter|description|
|----------|-----------|
|`object`|*(Required.)* **object**. |
|`object.id`|*(Required.)* **string**. The id of the object to get.|
|`object`|*(Required.) * **object**. |
|`object.id`|*(Required.) * **string**. The id of the object to get.|

### QueryMsg::Objects

Objects returns the list of objects in the bucket with support for pagination.

|parameter|description|
|----------|-----------|
|`objects`|*(Required.)* **object**. |
|`objects`|*(Required.) * **object**. |
|`objects.address`|**string\|null**. The owner of the objects to get.|
|`objects.after`|**string\|null**. The point in the sequence to start returning objects.|
|`objects.first`|**integer\|null**. The number of objects to return.|
Expand All @@ -202,19 +202,19 @@ ObjectData returns the content of the object with the given id.

|parameter|description|
|----------|-----------|
|`object_data`|*(Required.)* **object**. |
|`object_data.id`|*(Required.)* **string**. The id of the object to get.|
|`object_data`|*(Required.) * **object**. |
|`object_data.id`|*(Required.) * **string**. The id of the object to get.|

### QueryMsg::ObjectPins

ObjectPins returns the list of addresses that pinned the object with the given id with support for pagination.

|parameter|description|
|----------|-----------|
|`object_pins`|*(Required.)* **object**. |
|`object_pins`|*(Required.) * **object**. |
|`object_pins.after`|**string\|null**. The point in the sequence to start returning pins.|
|`object_pins.first`|**integer\|null**. The number of pins to return.|
|`object_pins.id`|*(Required.)* **string**. The id of the object to get the pins for.|
|`object_pins.id`|*(Required.) * **string**. The id of the object to get the pins for.|

## Responses

Expand All @@ -224,16 +224,16 @@ BucketResponse is the response of the Bucket query.

|property|description|
|----------|-----------|
|`config`|*(Required.)* **[BucketConfig](#bucketconfig)**. The configuration of the bucket.|
|`config`|*(Required.) * **[BucketConfig](#bucketconfig)**. The configuration of the bucket.|
|`config.accepted_compression_algorithms`|**Array&lt;[CompressionAlgorithm](#compressionalgorithm)&gt;**. The acceptable compression algorithms for the objects in the bucket. If this parameter is not set (none or empty array), then all compression algorithms are accepted. If this parameter is set, then only the compression algorithms in the array are accepted.<br /><br />When an object is stored in the bucket without a specified compression algorithm, the first algorithm in the array is used. Therefore, the order of the algorithms in the array is significant. Typically, the most efficient compression algorithm, such as the NoCompression algorithm, should be placed first in the array.<br /><br />Any attempt to store an object using a different compression algorithm than the ones specified here will fail.<br />**Default:** `["passthrough","snappy","lzma"]`|
|`config.hash_algorithm`|**[HashAlgorithm](#hashalgorithm)**. The algorithm used to hash the content of the objects to generate the id of the objects. The algorithm is optional and if not set, the default algorithm is used.<br /><br />The default algorithm is Sha256 if not set.<br />**Default:** `"sha256"`|
|`limits`|*(Required.)* **[BucketLimits](#bucketlimits)**. The limits of the bucket.|
|`limits`|*(Required.) * **[BucketLimits](#bucketlimits)**. The limits of the bucket.|
|`limits.max_object_pins`|**[Uint128](#uint128)\|null**. The maximum number of pins in the bucket for an object.|
|`limits.max_object_size`|**[Uint128](#uint128)\|null**. The maximum size of the objects in the bucket.|
|`limits.max_objects`|**[Uint128](#uint128)\|null**. The maximum number of objects in the bucket.|
|`limits.max_total_size`|**[Uint128](#uint128)\|null**. The maximum total size of the objects in the bucket.|
|`name`|*(Required.)* **string**. The name of the bucket.|
|`pagination`|*(Required.)* **[PaginationConfig](#paginationconfig)**. The configuration for paginated query.|
|`name`|*(Required.) * **string**. The name of the bucket.|
|`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 contains.<br /><br />Shall be less than `u32::MAX - 1`. Default to '30' if not set.<br />**Default:** `30`|

Expand All @@ -243,12 +243,12 @@ ObjectResponse is the response of the Object query.

|property|description|
|----------|-----------|
|`compressed_size`|*(Required.)* **[Uint128](#uint128)**. The size of the object when compressed. If the object is not compressed, the value is the same as `size`.|
|`compression_algorithm`|*(Required.)* **[CompressionAlgorithm](#compressionalgorithm)**. The compression algorithm used to compress the content of the object.|
|`id`|*(Required.)* **string**. The id of the object.|
|`is_pinned`|*(Required.)* **boolean**. Tells if the object is pinned by at least one address.|
|`owner`|*(Required.)* **string**. The owner of the object.|
|`size`|*(Required.)* **[Uint128](#uint128)**. The size of the object.|
|`compressed_size`|*(Required.) * **[Uint128](#uint128)**. The size of the object when compressed. If the object is not compressed, the value is the same as `size`.|
|`compression_algorithm`|*(Required.) * **[CompressionAlgorithm](#compressionalgorithm)**. The compression algorithm used to compress the content of the object.|
|`id`|*(Required.) * **string**. The id of the object.|
|`is_pinned`|*(Required.) * **boolean**. Tells if the object is pinned by at least one address.|
|`owner`|*(Required.) * **string**. The owner of the object.|
|`size`|*(Required.) * **[Uint128](#uint128)**. The size of the object.|

### object_data

Expand All @@ -266,8 +266,8 @@ ObjectPinsResponse is the response of the GetObjectPins query.

|property|description|
|----------|-----------|
|`data`|*(Required.)* **Array&lt;string&gt;**. The list of addresses that pinned the object.|
|`page_info`|*(Required.)* **[PageInfo](#pageinfo)**. The page information.|
|`data`|*(Required.) * **Array&lt;string&gt;**. The list of addresses that pinned the object.|
|`page_info`|*(Required.) * **[PageInfo](#pageinfo)**. The page information.|
|`page_info.cursor`|**string**. The cursor to the next page.|
|`page_info.has_next_page`|**boolean**. Tells if there is a next page.|

Expand All @@ -277,8 +277,8 @@ ObjectsResponse is the response of the Objects query.

|property|description|
|----------|-----------|
|`data`|*(Required.)* **Array&lt;[ObjectResponse](#objectresponse)&gt;**. The list of objects in the bucket.|
|`page_info`|*(Required.)* **[PageInfo](#pageinfo)**. The page information.|
|`data`|*(Required.) * **Array&lt;[ObjectResponse](#objectresponse)&gt;**. The list of objects in the bucket.|
|`page_info`|*(Required.) * **[PageInfo](#pageinfo)**. The page information.|
|`page_info.cursor`|**string**. The cursor to the next page.|
|`page_info.has_next_page`|**boolean**. Tells if there is a next page.|

Expand Down Expand Up @@ -368,21 +368,21 @@ ObjectResponse is the response of the Object query.

|property|description|
|----------|-----------|
|`compressed_size`|*(Required.)* **[Uint128](#uint128)**. The size of the object when compressed. If the object is not compressed, the value is the same as `size`.|
|`compression_algorithm`|*(Required.)* **[CompressionAlgorithm](#compressionalgorithm)**. The compression algorithm used to compress the content of the object.|
|`id`|*(Required.)* **string**. The id of the object.|
|`is_pinned`|*(Required.)* **boolean**. Tells if the object is pinned by at least one address.|
|`owner`|*(Required.)* **string**. The owner of the object.|
|`size`|*(Required.)* **[Uint128](#uint128)**. The size of the object.|
|`compressed_size`|*(Required.) * **[Uint128](#uint128)**. The size of the object when compressed. If the object is not compressed, the value is the same as `size`.|
|`compression_algorithm`|*(Required.) * **[CompressionAlgorithm](#compressionalgorithm)**. The compression algorithm used to compress the content of the object.|
|`id`|*(Required.) * **string**. The id of the object.|
|`is_pinned`|*(Required.) * **boolean**. Tells if the object is pinned by at least one address.|
|`owner`|*(Required.) * **string**. The owner of the object.|
|`size`|*(Required.) * **[Uint128](#uint128)**. The size of the object.|

### PageInfo

PageInfo is the page information returned for paginated queries.

|property|description|
|----------|-----------|
|`cursor`|*(Required.)* **string**. The cursor to the next page.|
|`has_next_page`|*(Required.)* **boolean**. Tells if there is a next page.|
|`cursor`|*(Required.) * **string**. The cursor to the next page.|
|`has_next_page`|*(Required.) * **boolean**. Tells if there is a next page.|

### PaginationConfig

Expand Down
34 changes: 17 additions & 17 deletions contracts_versioned_docs/version-v1.0.0/cw-law-stone.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Instantiate message

|parameter|description|
|----------|-----------|
|`program`|*(Required.)* **[Binary](#binary)**. The Prolog program carrying law rules and facts.|
|`storage_address`|*(Required.)* **string**. The `cw-storage` contract address on which to store the law program.|
|`program`|*(Required.) * **[Binary](#binary)**. The Prolog program carrying law rules and facts.|
|`storage_address`|*(Required.) * **string**. The `cw-storage` contract address on which to store the law program.|

## ExecuteMsg

Expand All @@ -45,8 +45,8 @@ If not broken, ask the logic module the provided query with the law program load

|parameter|description|
|----------|-----------|
|`ask`|*(Required.)* **object**. |
|`ask.query`|*(Required.)* **string**. |
|`ask`|*(Required.) * **object**. |
|`ask.query`|*(Required.) * **string**. |

### QueryMsg::Program

Expand All @@ -65,17 +65,17 @@ If not broken, returns the law program location information.
|property|description|
|----------|-----------|
|`answer`|**[Answer](#answer)\|null**. |
|`gas_used`|*(Required.)* **integer**. |
|`height`|*(Required.)* **integer**. |
|`gas_used`|*(Required.) * **integer**. |
|`height`|*(Required.) * **integer**. |

### program

ProgramResponse carry elements to locate the program in a `cw-storage` contract.

|property|description|
|----------|-----------|
|`object_id`|*(Required.)* **string**. The program object id in the `cw-storage` contract.|
|`storage_address`|*(Required.)* **string**. The `cw-storage` contract address on which the law program is stored.|
|`object_id`|*(Required.) * **string**. The program object id in the `cw-storage` contract.|
|`storage_address`|*(Required.) * **string**. The `cw-storage` contract address on which the law program is stored.|

## Definitions

Expand All @@ -85,10 +85,10 @@ ProgramResponse carry elements to locate the program in a `cw-storage` contract.

|property|description|
|----------|-----------|
|`has_more`|*(Required.)* **boolean**. |
|`results`|*(Required.)* **Array&lt;[Result](#result)&gt;**. |
|`success`|*(Required.)* **boolean**. |
|`variables`|*(Required.)* **Array&lt;string&gt;**. |
|`has_more`|*(Required.) * **boolean**. |
|`results`|*(Required.) * **Array&lt;[Result](#result)&gt;**. |
|`success`|*(Required.) * **boolean**. |
|`variables`|*(Required.) * **Array&lt;string&gt;**. |

### Binary

Expand All @@ -104,22 +104,22 @@ A string containing Base64-encoded data.

|property|description|
|----------|-----------|
|`substitutions`|*(Required.)* **Array&lt;[Substitution](#substitution)&gt;**. |
|`substitutions`|*(Required.) * **Array&lt;[Substitution](#substitution)&gt;**. |

### Substitution



|property|description|
|----------|-----------|
|`term`|*(Required.)* **object**. |
|`variable`|*(Required.)* **string**. |
|`term`|*(Required.) * **object**. |
|`variable`|*(Required.) * **string**. |

### Term



|property|description|
|----------|-----------|
|`arguments`|*(Required.)* **Array&lt;[Term](#term)&gt;**. |
|`name`|*(Required.)* **string**. |
|`arguments`|*(Required.) * **Array&lt;[Term](#term)&gt;**. |
|`name`|*(Required.) * **string**. |
Loading

0 comments on commit 6b1cabe

Please sign in to comment.