Browse Source

Update autogenerated docs

Leszek Wiesner 3 years ago
parent
commit
56049cd87c
22 changed files with 224 additions and 53 deletions
  1. 0 25
      distributor-node/docs/schema/README.md
  2. 1 1
      distributor-node/docs/schema/definition-properties-buckets-oneof-all-buckets.md
  3. 0 0
      distributor-node/docs/schema/definition-properties-buckets-oneof-bucket-ids-items.md
  4. 0 0
      distributor-node/docs/schema/definition-properties-buckets-oneof-bucket-ids.md
  5. 2 2
      distributor-node/docs/schema/definition-properties-buckets.md
  6. 0 3
      distributor-node/docs/schema/definition-properties-directories-assets.md
  7. 0 3
      distributor-node/docs/schema/definition-properties-directories-cachestate.md
  8. 0 3
      distributor-node/docs/schema/definition-properties-directories-logs.md
  9. 0 3
      distributor-node/docs/schema/definition-properties-directories-properties-cache.md
  10. 0 3
      distributor-node/docs/schema/definition-properties-directories-properties-data.md
  11. 0 3
      distributor-node/docs/schema/definition-properties-endpoints-properties-substratenode.md
  12. 3 0
      distributor-node/docs/schema/definition-properties-keys-items-oneof-json-backup-file-properties-keyfile.md
  13. 27 0
      distributor-node/docs/schema/definition-properties-keys-items-oneof-json-backup-file.md
  14. 3 0
      distributor-node/docs/schema/definition-properties-keys-items-oneof-mnemonic-phrase-properties-mnemonic.md
  15. 21 0
      distributor-node/docs/schema/definition-properties-keys-items-oneof-mnemonic-phrase-properties-type.md
  16. 64 0
      distributor-node/docs/schema/definition-properties-keys-items-oneof-mnemonic-phrase.md
  17. 3 0
      distributor-node/docs/schema/definition-properties-keys-items-oneof-substrate-uri-properties-suri.md
  18. 21 0
      distributor-node/docs/schema/definition-properties-keys-items-oneof-substrate-uri-properties-type.md
  19. 64 0
      distributor-node/docs/schema/definition-properties-keys-items-oneof-substrate-uri.md
  20. 9 1
      distributor-node/docs/schema/definition-properties-keys-items.md
  21. 1 1
      distributor-node/docs/schema/definition-properties-keys.md
  22. 5 5
      distributor-node/docs/schema/definition.md

+ 0 - 25
distributor-node/docs/schema/README.md

@@ -1,25 +0,0 @@
-# README
-
-## Top-level Schemas
-
-*   [Distributor node configuration](./definition.md "Configuration schema for distirubtor CLI and node") – `-`
-
-## Other Schemas
-
-### Objects
-
-*   [Untitled object in Distributor node configuration](./definition-properties-endpoints.md "Specifies external endpoints that the distributor node will connect to") – `undefined#/properties/endpoints`
-
-*   [Untitled object in Distributor node configuration](./definition-properties-directories.md "Specifies paths where node's data will be stored") – `undefined#/properties/directories`
-
-*   [Untitled object in Distributor node configuration](./definition-properties-log.md "Specifies minimum log levels by supported log outputs") – `undefined#/properties/log`
-
-*   [Untitled object in Distributor node configuration](./definition-properties-limits.md "Specifies node limits w") – `undefined#/properties/limits`
-
-*   [Untitled object in Distributor node configuration](./definition-properties-intervals.md "Specifies how often periodic tasks (for example cache cleanup) are executed by the node") – `undefined#/properties/intervals`
-
-### Arrays
-
-*   [Untitled array in Distributor node configuration](./definition-properties-keys.md "Specifies the keys to use within distributor node CLI") – `undefined#/properties/keys`
-
-*   [Untitled array in Distributor node configuration](./definition-properties-buckets-oneof-0.md "List of distribution bucket ids") – `undefined#/properties/buckets/oneOf/0`

+ 1 - 1
distributor-node/docs/schema/definition-properties-buckets-oneof-1.md → distributor-node/docs/schema/definition-properties-buckets-oneof-all-buckets.md

@@ -1,6 +1,6 @@
 ## 1 Type
 
-`string`
+`string` ([All buckets](definition-properties-buckets-oneof-all-buckets.md))
 
 ## 1 Constraints
 

+ 0 - 0
distributor-node/docs/schema/definition-properties-buckets-oneof-0-items.md → distributor-node/docs/schema/definition-properties-buckets-oneof-bucket-ids-items.md


+ 0 - 0
distributor-node/docs/schema/definition-properties-buckets-oneof-0.md → distributor-node/docs/schema/definition-properties-buckets-oneof-bucket-ids.md


+ 2 - 2
distributor-node/docs/schema/definition-properties-buckets.md

@@ -4,6 +4,6 @@ merged type ([Details](definition-properties-buckets.md))
 
 one (and only one) of
 
-*   [Untitled array in Distributor node configuration](definition-properties-buckets-oneof-0.md "check type definition")
+*   [Bucket ids](definition-properties-buckets-oneof-bucket-ids.md "check type definition")
 
-*   [Untitled string in Distributor node configuration](definition-properties-buckets-oneof-1.md "check type definition")
+*   [All buckets](definition-properties-buckets-oneof-all-buckets.md "check type definition")

+ 0 - 3
distributor-node/docs/schema/definition-properties-directories-assets.md

@@ -1,3 +0,0 @@
-## assets Type
-
-`string`

+ 0 - 3
distributor-node/docs/schema/definition-properties-directories-cachestate.md

@@ -1,3 +0,0 @@
-## cacheState Type
-
-`string`

+ 0 - 3
distributor-node/docs/schema/definition-properties-directories-logs.md

@@ -1,3 +0,0 @@
-## logs Type
-
-`string`

+ 0 - 3
distributor-node/docs/schema/definition-properties-directories-properties-cache.md

@@ -1,3 +0,0 @@
-## cache Type
-
-`string`

+ 0 - 3
distributor-node/docs/schema/definition-properties-directories-properties-data.md

@@ -1,3 +0,0 @@
-## data Type
-
-`string`

+ 0 - 3
distributor-node/docs/schema/definition-properties-endpoints-properties-substratenode.md

@@ -1,3 +0,0 @@
-## substrateNode Type
-
-`string`

+ 3 - 0
distributor-node/docs/schema/definition-properties-keys-items-oneof-json-backup-file-properties-keyfile.md

@@ -0,0 +1,3 @@
+## keyfile Type
+
+`string`

+ 27 - 0
distributor-node/docs/schema/definition-properties-keys-items-oneof-json-backup-file.md

@@ -0,0 +1,27 @@
+## 2 Type
+
+`object` ([JSON backup file](definition-properties-keys-items-oneof-json-backup-file.md))
+
+# 2 Properties
+
+| Property            | Type     | Required | Nullable       | Defined by                                                                                                                                                                    |
+| :------------------ | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [keyfile](#keyfile) | `string` | Required | cannot be null | [Distributor node configuration](definition-properties-keys-items-oneof-json-backup-file-properties-keyfile.md "undefined#/properties/keys/items/oneOf/2/properties/keyfile") |
+
+## keyfile
+
+
+
+`keyfile`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Distributor node configuration](definition-properties-keys-items-oneof-json-backup-file-properties-keyfile.md "undefined#/properties/keys/items/oneOf/2/properties/keyfile")
+
+### keyfile Type
+
+`string`

+ 3 - 0
distributor-node/docs/schema/definition-properties-keys-items-oneof-mnemonic-phrase-properties-mnemonic.md

@@ -0,0 +1,3 @@
+## mnemonic Type
+
+`string`

+ 21 - 0
distributor-node/docs/schema/definition-properties-keys-items-oneof-mnemonic-phrase-properties-type.md

@@ -0,0 +1,21 @@
+## type Type
+
+`string`
+
+## type Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"ed25519"` |             |
+| `"sr25519"` |             |
+| `"ecdsa"`   |             |
+
+## type Default Value
+
+The default value is:
+
+```json
+"sr25519"
+```

+ 64 - 0
distributor-node/docs/schema/definition-properties-keys-items-oneof-mnemonic-phrase.md

@@ -0,0 +1,64 @@
+## 1 Type
+
+`object` ([Mnemonic phrase](definition-properties-keys-items-oneof-mnemonic-phrase.md))
+
+# 1 Properties
+
+| Property              | Type     | Required | Nullable       | Defined by                                                                                                                                                                     |
+| :-------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [type](#type)         | `string` | Optional | cannot be null | [Distributor node configuration](definition-properties-keys-items-oneof-mnemonic-phrase-properties-type.md "undefined#/properties/keys/items/oneOf/1/properties/type")         |
+| [mnemonic](#mnemonic) | `string` | Required | cannot be null | [Distributor node configuration](definition-properties-keys-items-oneof-mnemonic-phrase-properties-mnemonic.md "undefined#/properties/keys/items/oneOf/1/properties/mnemonic") |
+
+## type
+
+
+
+`type`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Distributor node configuration](definition-properties-keys-items-oneof-mnemonic-phrase-properties-type.md "undefined#/properties/keys/items/oneOf/1/properties/type")
+
+### type Type
+
+`string`
+
+### type Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"ed25519"` |             |
+| `"sr25519"` |             |
+| `"ecdsa"`   |             |
+
+### type Default Value
+
+The default value is:
+
+```json
+"sr25519"
+```
+
+## mnemonic
+
+
+
+`mnemonic`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Distributor node configuration](definition-properties-keys-items-oneof-mnemonic-phrase-properties-mnemonic.md "undefined#/properties/keys/items/oneOf/1/properties/mnemonic")
+
+### mnemonic Type
+
+`string`

+ 3 - 0
distributor-node/docs/schema/definition-properties-keys-items-oneof-substrate-uri-properties-suri.md

@@ -0,0 +1,3 @@
+## suri Type
+
+`string`

+ 21 - 0
distributor-node/docs/schema/definition-properties-keys-items-oneof-substrate-uri-properties-type.md

@@ -0,0 +1,21 @@
+## type Type
+
+`string`
+
+## type Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"ed25519"` |             |
+| `"sr25519"` |             |
+| `"ecdsa"`   |             |
+
+## type Default Value
+
+The default value is:
+
+```json
+"sr25519"
+```

+ 64 - 0
distributor-node/docs/schema/definition-properties-keys-items-oneof-substrate-uri.md

@@ -0,0 +1,64 @@
+## 0 Type
+
+`object` ([Substrate uri](definition-properties-keys-items-oneof-substrate-uri.md))
+
+# 0 Properties
+
+| Property      | Type     | Required | Nullable       | Defined by                                                                                                                                                           |
+| :------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [type](#type) | `string` | Optional | cannot be null | [Distributor node configuration](definition-properties-keys-items-oneof-substrate-uri-properties-type.md "undefined#/properties/keys/items/oneOf/0/properties/type") |
+| [suri](#suri) | `string` | Required | cannot be null | [Distributor node configuration](definition-properties-keys-items-oneof-substrate-uri-properties-suri.md "undefined#/properties/keys/items/oneOf/0/properties/suri") |
+
+## type
+
+
+
+`type`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Distributor node configuration](definition-properties-keys-items-oneof-substrate-uri-properties-type.md "undefined#/properties/keys/items/oneOf/0/properties/type")
+
+### type Type
+
+`string`
+
+### type Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"ed25519"` |             |
+| `"sr25519"` |             |
+| `"ecdsa"`   |             |
+
+### type Default Value
+
+The default value is:
+
+```json
+"sr25519"
+```
+
+## suri
+
+
+
+`suri`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Distributor node configuration](definition-properties-keys-items-oneof-substrate-uri-properties-suri.md "undefined#/properties/keys/items/oneOf/0/properties/suri")
+
+### suri Type
+
+`string`

+ 9 - 1
distributor-node/docs/schema/definition-properties-keys-items.md

@@ -1,3 +1,11 @@
 ## items Type
 
-`string`
+merged type ([Details](definition-properties-keys-items.md))
+
+one (and only one) of
+
+*   [Substrate uri](definition-properties-keys-items-oneof-substrate-uri.md "check type definition")
+
+*   [Mnemonic phrase](definition-properties-keys-items-oneof-mnemonic-phrase.md "check type definition")
+
+*   [JSON backup file](definition-properties-keys-items-oneof-json-backup-file.md "check type definition")

+ 1 - 1
distributor-node/docs/schema/definition-properties-keys.md

@@ -1,6 +1,6 @@
 ## keys Type
 
-`string[]`
+an array of merged types ([Details](definition-properties-keys-items.md))
 
 ## keys Constraints
 

+ 5 - 5
distributor-node/docs/schema/definition.md

@@ -153,13 +153,13 @@ Distributor node http server port
 
 ## keys
 
-Specifies the keys to use within distributor node CLI. Must be provided in form of substrate uris (ie.: //Alice)
+Specifies the keys available within distributor node CLI.
 
 `keys`
 
 *   is required
 
-*   Type: `string[]`
+*   Type: an array of merged types ([Details](definition-properties-keys-items.md))
 
 *   cannot be null
 
@@ -167,7 +167,7 @@ Specifies the keys to use within distributor node CLI. Must be provided in form
 
 ### keys Type
 
-`string[]`
+an array of merged types ([Details](definition-properties-keys-items.md))
 
 ### keys Constraints
 
@@ -193,9 +193,9 @@ merged type ([Details](definition-properties-buckets.md))
 
 one (and only one) of
 
-*   [Untitled array in Distributor node configuration](definition-properties-buckets-oneof-0.md "check type definition")
+*   [Bucket ids](definition-properties-buckets-oneof-bucket-ids.md "check type definition")
 
-*   [Untitled string in Distributor node configuration](definition-properties-buckets-oneof-1.md "check type definition")
+*   [All buckets](definition-properties-buckets-oneof-all-buckets.md "check type definition")
 
 ## workerId