From 3ab48fab3af598113f2a79afeb09508c948d054f Mon Sep 17 00:00:00 2001 From: mrjk Date: Sat, 15 Jan 2022 17:47:15 -0500 Subject: [PATCH] Add: Autogenerated doc --- docs/docs_md/main.md | 357 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 357 insertions(+) create mode 100644 docs/docs_md/main.md diff --git a/docs/docs_md/main.md b/docs/docs_md/main.md new file mode 100644 index 0000000..4dd9a3e --- /dev/null +++ b/docs/docs_md/main.md @@ -0,0 +1,357 @@ +# Schema Docs + +- [1. [Optional]Pattern Property `root > .*`](#pattern1) + - [1.1. [Optional] Property `root > .* > config`](#pattern1_config) + - [1.1.1. [Optional] Property `root > .* > config > app`](#pattern1_config_app) + - [1.1.1.1. [Optional] Property `root > .* > config > app > root`](#pattern1_config_app_root) + - [1.1.2. [Optional] Property `root > .* > config > tree`](#pattern1_config_tree) + - [1.1.3. [Optional] Property `root > .* > config > rules`](#pattern1_config_rules) + - [1.2. [Optional] Property `root > .* > tree`](#pattern1_tree) + - [1.2.1. root > .* > tree > tree items](#autogenerated_heading_2) + - [1.2.1.1. Property `root > .* > tree > tree items > oneOf > item 0`](#pattern1_tree_items_oneOf_i0) + - [1.2.1.2. Property `root > .* > tree > tree items > oneOf > item 1`](#pattern1_tree_items_oneOf_i1) + - [1.2.1.2.1. Property `root > .* > tree > tree items > oneOf > item 1 > schema`](#pattern1_tree_items_oneOf_i1_schema) + - [1.2.1.2.1.1. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 0`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i0) + - [1.2.1.2.1.2. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 1`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i1) + - [1.2.1.2.1.3. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 2`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i2) + - [1.2.1.2.1.4. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3) + - [1.2.1.2.1.4.1. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > data`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_data) + - [1.2.1.2.1.4.1.1. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > data > anyOf > item 0`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_data_anyOf_i0) + - [1.2.1.2.1.4.1.2. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > data > anyOf > item 1`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_data_anyOf_i1) + - [1.2.1.2.1.4.1.3. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > data > anyOf > item 2`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_data_anyOf_i2) + - [1.2.1.2.1.4.2. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > var`](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_var) + - [1.2.1.2.2. Property `root > .* > tree > tree items > oneOf > item 1 > rule`](#pattern1_tree_items_oneOf_i1_rule) + - [1.2.1.2.2.1. Property `root > .* > tree > tree items > oneOf > item 1 > rule > oneOf > item 0`](#pattern1_tree_items_oneOf_i1_rule_oneOf_i0) + - [1.2.1.2.2.2. Property `root > .* > tree > tree items > oneOf > item 1 > rule > oneOf > item 1`](#pattern1_tree_items_oneOf_i1_rule_oneOf_i1) + - [1.2.1.2.3. Property `root > .* > tree > tree items > oneOf > item 1 > strategy`](#pattern1_tree_items_oneOf_i1_strategy) + - [1.2.1.2.4. Property `root > .* > tree > tree items > oneOf > item 1 > trace`](#pattern1_tree_items_oneOf_i1_trace) + - [1.2.1.2.5. Property `root > .* > tree > tree items > oneOf > item 1 > explain`](#pattern1_tree_items_oneOf_i1_explain) + - [1.3. [Optional] Property `root > .* > rules`](#pattern1_rules) + +| Type | `object` | +| ------------------------- | ------------------------------------------------------- | +| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| **Default** | `{}` | +| | | + +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------ | ------- | ------ | ---------- | ---------- | ----------------- | +| - [.*](#pattern1 ) | Yes | object | No | - | - | +| | | | | | | + +## 1. [Optional]Pattern Property `root > .*` +> All property whose name matches the regular expression +```.*``` ([Test](https://regex101.com/?regex=.%2A)) +must respect the following conditions + +| Type | `object` | +| ------------------------- | ------------------------------------------------------- | +| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | + +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | +| - [config](#pattern1_config ) | No | object | No | - | - | +| - [tree](#pattern1_tree ) | No | array | No | - | - | +| - [rules](#pattern1_rules ) | No | array | No | - | - | +| | | | | | | + +### 1.1. [Optional] Property `root > .* > config` + +| Type | `object` | +| ------------------------- | ------------------------------------------------------- | +| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| **Default** | `{"app": {"root": null}, "tree": {}, "rules": {}}` | +| | | + +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | +| - [app](#pattern1_config_app ) | No | object | No | - | - | +| - [tree](#pattern1_config_tree ) | No | object | No | - | - | +| - [rules](#pattern1_config_rules ) | No | object | No | - | - | +| | | | | | | + +#### 1.1.1. [Optional] Property `root > .* > config > app` + +| Type | `object` | +| ------------------------- | ------------------------------------------------------- | +| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| **Default** | `{"root": null}` | +| | | + +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------- | +| - [root](#pattern1_config_app_root ) | No | string | No | - | - | +| | | | | | | + +##### 1.1.1.1. [Optional] Property `root > .* > config > app > root` + +| Type | `string` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `null` | +| | | + +#### 1.1.2. [Optional] Property `root > .* > config > tree` + +| Type | `object` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `{}` | +| | | + +#### 1.1.3. [Optional] Property `root > .* > config > rules` + +| Type | `object` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `{}` | +| | | + +### 1.2. [Optional] Property `root > .* > tree` + +| Type | `array` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `[]` | +| | | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | +| | | + +| Each item of this array must be | Description | +| ---------------------------------- | ----------- | +| [tree items](#pattern1_tree_items) | - | +| | | + +#### 1.2.1. root > .* > tree > tree items + +| Type | `combining` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `""` | +| | | + +| One of(Option) | +| --------------------------------------- | +| [item 0](#pattern1_tree_items_oneOf_i0) | +| [item 1](#pattern1_tree_items_oneOf_i1) | +| | + +##### 1.2.1.1. Property `root > .* > tree > tree items > oneOf > item 0` + +| Type | `string` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `"BLAAAAHHH"` | +| | | + +##### 1.2.1.2. Property `root > .* > tree > tree items > oneOf > item 1` + +| Type | `object` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `{}` | +| | | + +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- | +| - [schema](#pattern1_tree_items_oneOf_i1_schema ) | No | Combination | No | - | - | +| - [rule](#pattern1_tree_items_oneOf_i1_rule ) | No | Combination | No | - | - | +| - [strategy](#pattern1_tree_items_oneOf_i1_strategy ) | No | string | No | - | - | +| - [trace](#pattern1_tree_items_oneOf_i1_trace ) | No | boolean | No | - | - | +| - [explain](#pattern1_tree_items_oneOf_i1_explain ) | No | boolean | No | - | - | +| - [additionalProperties](#pattern1_tree_items_oneOf_i1_additionalProperties ) | No | object | No | - | - | +| | | | | | | + +##### 1.2.1.2.1. Property `root > .* > tree > tree items > oneOf > item 1 > schema` + +| Type | `combining` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `null` | +| | | + +| One of(Option) | +| ------------------------------------------------------- | +| [item 0](#pattern1_tree_items_oneOf_i1_schema_oneOf_i0) | +| [item 1](#pattern1_tree_items_oneOf_i1_schema_oneOf_i1) | +| [item 2](#pattern1_tree_items_oneOf_i1_schema_oneOf_i2) | +| [item 3](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3) | +| | + +##### 1.2.1.2.1.1. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 0` + +| Type | `null` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | + +##### 1.2.1.2.1.2. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 1` + +| Type | `string` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | + +##### 1.2.1.2.1.3. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 2` + +| Type | `array` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | N/A | +| | | + +##### 1.2.1.2.1.4. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3` + +| Type | `object` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `{}` | +| | | + +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- | +| - [data](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_data ) | No | Combination | No | - | - | +| - [var](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_var ) | No | string | No | - | - | +| - [additionalProperties](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_additionalProperties ) | No | object | No | - | - | +| | | | | | | + +##### 1.2.1.2.1.4.1. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > data` + +| Type | `combining` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `null` | +| | | + +| Any of(Option) | +| --------------------------------------------------------------------- | +| [item 0](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_data_anyOf_i0) | +| [item 1](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_data_anyOf_i1) | +| [item 2](#pattern1_tree_items_oneOf_i1_schema_oneOf_i3_data_anyOf_i2) | +| | + +##### 1.2.1.2.1.4.1.1. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > data > anyOf > item 0` + +| Type | `null` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | + +##### 1.2.1.2.1.4.1.2. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > data > anyOf > item 1` + +| Type | `string` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | + +##### 1.2.1.2.1.4.1.3. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > data > anyOf > item 2` + +| Type | `array` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | N/A | +| | | + +##### 1.2.1.2.1.4.2. Property `root > .* > tree > tree items > oneOf > item 1 > schema > oneOf > item 3 > var` + +| Type | `string` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `"loop_item"` | +| | | + +##### 1.2.1.2.2. Property `root > .* > tree > tree items > oneOf > item 1 > rule` + +| Type | `combining` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `".*"` | +| | | + +| One of(Option) | +| ----------------------------------------------------- | +| [item 0](#pattern1_tree_items_oneOf_i1_rule_oneOf_i0) | +| [item 1](#pattern1_tree_items_oneOf_i1_rule_oneOf_i1) | +| | + +##### 1.2.1.2.2.1. Property `root > .* > tree > tree items > oneOf > item 1 > rule > oneOf > item 0` + +| Type | `string` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | + +##### 1.2.1.2.2.2. Property `root > .* > tree > tree items > oneOf > item 1 > rule > oneOf > item 1` + +| Type | `null` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | + +##### 1.2.1.2.3. Property `root > .* > tree > tree items > oneOf > item 1 > strategy` + +| Type | `string` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `"schema"` | +| | | + +##### 1.2.1.2.4. Property `root > .* > tree > tree items > oneOf > item 1 > trace` + +| Type | `boolean` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `false` | +| | | + +##### 1.2.1.2.5. Property `root > .* > tree > tree items > oneOf > item 1 > explain` + +| Type | `boolean` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `false` | +| | | + +### 1.3. [Optional] Property `root > .* > rules` + +| Type | `array` | +| ------------------------- | ------------------------------------------------------------------------- | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `[]` | +| | | + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | N/A | +| | | + +---------------------------------------------------------------------------------------------------------------------------- +Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2022-01-15 at 17:47:14 -0500 \ No newline at end of file