Skip to content

Commit

Permalink
chore(objectarium): update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikssonJoakim committed Jul 31, 2023
1 parent 79fcb4c commit 1c3ce3a
Show file tree
Hide file tree
Showing 18 changed files with 152 additions and 9 deletions.
25 changes: 25 additions & 0 deletions docs/okp4-objectarium-executemsg-definitions-compressionalgorithm-oneof-lzma.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Lzma Schema

```txt
undefined#/execute/definitions/CompressionAlgorithm/oneOf/2
```

Represents the LZMA algorithm. LZMA is a lossless data compression/decompression algorithm that features a high compression ratio and a variable compression-dictionary size up to 4 GB.

See [the LZMA wiki page](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Markov_chain_algorithm) for more information.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [okp4-objectarium.json\*](schema/okp4-objectarium.json "open original schema") |

## 2 Type

`string` ([Lzma](okp4-objectarium-executemsg-definitions-compressionalgorithm-oneof-lzma.md))

## 2 Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :------- | :---------- |
| `"lzma"` | |
2 changes: 2 additions & 0 deletions docs/okp4-objectarium-executemsg-definitions-compressionalgorithm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ one (and only one) of
* [Passthrough](okp4-objectarium-executemsg-definitions-compressionalgorithm-oneof-passthrough.md "check type definition")

* [Snappy](okp4-objectarium-executemsg-definitions-compressionalgorithm-oneof-snappy.md "check type definition")

* [Lzma](okp4-objectarium-executemsg-definitions-compressionalgorithm-oneof-lzma.md "check type definition")
3 changes: 2 additions & 1 deletion ...tiatemsg-definitions-bucketconfig-properties-accepted_compression_algorithms.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The default value is:
```json
[
"passthrough",
"snappy"
"snappy",
"lzma"
]
```
3 changes: 2 additions & 1 deletion docs/okp4-objectarium-instantiatemsg-definitions-bucketconfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ The default value is:
```json
[
"passthrough",
"snappy"
"snappy",
"lzma"
]
```

Expand Down
25 changes: 25 additions & 0 deletions .../okp4-objectarium-instantiatemsg-definitions-compressionalgorithm-oneof-lzma.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Lzma Schema

```txt
undefined#/instantiate/definitions/CompressionAlgorithm/oneOf/2
```

Represents the LZMA algorithm. LZMA is a lossless data compression/decompression algorithm that features a high compression ratio and a variable compression-dictionary size up to 4 GB.

See [the LZMA wiki page](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Markov_chain_algorithm) for more information.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [okp4-objectarium.json\*](schema/okp4-objectarium.json "open original schema") |

## 2 Type

`string` ([Lzma](okp4-objectarium-instantiatemsg-definitions-compressionalgorithm-oneof-lzma.md))

## 2 Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :------- | :---------- |
| `"lzma"` | |
2 changes: 2 additions & 0 deletions docs/okp4-objectarium-instantiatemsg-definitions-compressionalgorithm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ one (and only one) of
* [Passthrough](okp4-objectarium-instantiatemsg-definitions-compressionalgorithm-oneof-passthrough.md "check type definition")

* [Snappy](okp4-objectarium-instantiatemsg-definitions-compressionalgorithm-oneof-snappy.md "check type definition")

* [Lzma](okp4-objectarium-instantiatemsg-definitions-compressionalgorithm-oneof-lzma.md "check type definition")
3 changes: 2 additions & 1 deletion docs/okp4-objectarium-instantiatemsg-properties-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ The default value is:
{
"accepted_compression_algorithms": [
"passthrough",
"snappy"
"snappy",
"lzma"
],
"hash_algorithm": "sha256"
}
Expand Down
6 changes: 4 additions & 2 deletions docs/okp4-objectarium-instantiatemsg.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ The default value is:
{
"accepted_compression_algorithms": [
"passthrough",
"snappy"
"snappy",
"lzma"
],
"hash_algorithm": "sha256"
}
Expand Down Expand Up @@ -189,7 +190,8 @@ The default value is:
```json
[
"passthrough",
"snappy"
"snappy",
"lzma"
]
```

Expand Down
3 changes: 2 additions & 1 deletion ...response-definitions-bucketconfig-properties-accepted_compression_algorithms.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The default value is:
```json
[
"passthrough",
"snappy"
"snappy",
"lzma"
]
```
3 changes: 2 additions & 1 deletion docs/okp4-objectarium-responses-bucketresponse-definitions-bucketconfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ The default value is:
```json
[
"passthrough",
"snappy"
"snappy",
"lzma"
]
```

Expand Down
25 changes: 25 additions & 0 deletions ...ctarium-responses-bucketresponse-definitions-compressionalgorithm-oneof-lzma.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Lzma Schema

```txt
undefined#/responses/bucket/definitions/CompressionAlgorithm/oneOf/2
```

Represents the LZMA algorithm. LZMA is a lossless data compression/decompression algorithm that features a high compression ratio and a variable compression-dictionary size up to 4 GB.

See [the LZMA wiki page](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Markov_chain_algorithm) for more information.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [okp4-objectarium.json\*](schema/okp4-objectarium.json "open original schema") |

## 2 Type

`string` ([Lzma](okp4-objectarium-responses-bucketresponse-definitions-compressionalgorithm-oneof-lzma.md))

## 2 Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :------- | :---------- |
| `"lzma"` | |
2 changes: 2 additions & 0 deletions docs/okp4-objectarium-responses-bucketresponse-definitions-compressionalgorithm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ one (and only one) of
* [Passthrough](okp4-objectarium-responses-bucketresponse-definitions-compressionalgorithm-oneof-passthrough.md "check type definition")

* [Snappy](okp4-objectarium-responses-bucketresponse-definitions-compressionalgorithm-oneof-snappy.md "check type definition")

* [Lzma](okp4-objectarium-responses-bucketresponse-definitions-compressionalgorithm-oneof-lzma.md "check type definition")
3 changes: 2 additions & 1 deletion docs/okp4-objectarium-responses-bucketresponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,8 @@ The default value is:
```json
[
"passthrough",
"snappy"
"snappy",
"lzma"
]
```

Expand Down
25 changes: 25 additions & 0 deletions ...ctarium-responses-objectresponse-definitions-compressionalgorithm-oneof-lzma.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Lzma Schema

```txt
undefined#/responses/object/definitions/CompressionAlgorithm/oneOf/2
```

Represents the LZMA algorithm. LZMA is a lossless data compression/decompression algorithm that features a high compression ratio and a variable compression-dictionary size up to 4 GB.

See [the LZMA wiki page](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Markov_chain_algorithm) for more information.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [okp4-objectarium.json\*](schema/okp4-objectarium.json "open original schema") |

## 2 Type

`string` ([Lzma](okp4-objectarium-responses-objectresponse-definitions-compressionalgorithm-oneof-lzma.md))

## 2 Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :------- | :---------- |
| `"lzma"` | |
2 changes: 2 additions & 0 deletions docs/okp4-objectarium-responses-objectresponse-definitions-compressionalgorithm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ one (and only one) of
* [Passthrough](okp4-objectarium-responses-objectresponse-definitions-compressionalgorithm-oneof-passthrough.md "check type definition")

* [Snappy](okp4-objectarium-responses-objectresponse-definitions-compressionalgorithm-oneof-snappy.md "check type definition")

* [Lzma](okp4-objectarium-responses-objectresponse-definitions-compressionalgorithm-oneof-lzma.md "check type definition")
25 changes: 25 additions & 0 deletions ...tarium-responses-objectsresponse-definitions-compressionalgorithm-oneof-lzma.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Lzma Schema

```txt
undefined#/responses/objects/definitions/CompressionAlgorithm/oneOf/2
```

Represents the LZMA algorithm. LZMA is a lossless data compression/decompression algorithm that features a high compression ratio and a variable compression-dictionary size up to 4 GB.

See [the LZMA wiki page](https://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Markov_chain_algorithm) for more information.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [okp4-objectarium.json\*](schema/okp4-objectarium.json "open original schema") |

## 2 Type

`string` ([Lzma](okp4-objectarium-responses-objectsresponse-definitions-compressionalgorithm-oneof-lzma.md))

## 2 Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :------- | :---------- |
| `"lzma"` | |
2 changes: 2 additions & 0 deletions .../okp4-objectarium-responses-objectsresponse-definitions-compressionalgorithm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ one (and only one) of
* [Passthrough](okp4-objectarium-responses-objectsresponse-definitions-compressionalgorithm-oneof-passthrough.md "check type definition")

* [Snappy](okp4-objectarium-responses-objectsresponse-definitions-compressionalgorithm-oneof-snappy.md "check type definition")

* [Lzma](okp4-objectarium-responses-objectsresponse-definitions-compressionalgorithm-oneof-lzma.md "check type definition")
2 changes: 1 addition & 1 deletion docs/schema/okp4-objectarium.json
View file

Large diffs are not rendered by default.

0 comments on commit 1c3ce3a

Please sign in to comment.