pro-barbu-foss/kheops

mrjk 3ab48fab3a Add: Autogenerated doc

2022-01-15 17:47:15 -05:00

28 KiB

Raw Blame History

Schema Docs

1. [Optional]Pattern Property root > .*

Type	`object`
Additional properties	[Not allowed]
Default	`{}`

Property	Pattern	Type	Deprecated	Definition	Title/Description
- .*	Yes	object	No	-	-

1. [Optional]Pattern Property `root > .*`

All property whose name matches the regular expression .* (Test) must respect the following conditions

Type	`object`
Additional properties	[Not allowed]

Property	Pattern	Type	Deprecated	Definition	Title/Description
- config	No	object	No	-	-
- tree	No	array	No	-	-
- rules	No	array	No	-	-

1.1. [Optional] Property `root > .* > config`

Type	`object`
Additional properties	[Not allowed]
Default	`{"app": {"root": null}, "tree": {}, "rules": {}}`

Property	Pattern	Type	Deprecated	Definition	Title/Description
- app	No	object	No	-	-
- tree	No	object	No	-	-
- rules	No	object	No	-	-

1.1.1. [Optional] Property `root > .* > config > app`

Type	`object`
Additional properties	[Not allowed]
Default	`{"root": null}`

Property	Pattern	Type	Deprecated	Definition	Title/Description
- root	No	string	No	-	-

1.1.1.1. [Optional] Property `root > .* > config > app > root`

Type	`string`
Additional properties	[Any type: allowed]
Default	`null`

1.1.2. [Optional] Property `root > .* > config > tree`

Type	`object`
Additional properties	[Any type: allowed]
Default	`{}`

1.1.3. [Optional] Property `root > .* > config > rules`

Type	`object`
Additional properties	[Any type: allowed]
Default	`{}`

1.2. [Optional] Property `root > .* > tree`

Type	`array`
Additional properties	[Any type: 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	-

1.2.1. root > .* > tree > tree items

Type	`combining`
Additional properties	[Any type: allowed]
Default	`""`

One of(Option)
item 0
item 1

1.2.1.1. Property `root > .* > tree > tree items > oneOf > item 0`

Type	`string`
Additional properties	[Any type: allowed]
Default	`"BLAAAAHHH"`

1.2.1.2. Property `root > .* > tree > tree items > oneOf > item 1`

Type	`object`
Additional properties	[Any type: allowed]
Default	`{}`

Property	Pattern	Type	Deprecated	Definition	Title/Description
- schema	No	Combination	No	-	-
- rule	No	Combination	No	-	-
- strategy	No	string	No	-	-
- trace	No	boolean	No	-	-
- explain	No	boolean	No	-	-
- 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]
Default	`null`

One of(Option)
item 0
item 1
item 2
item 3

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]

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]

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]

	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]
Default	`{}`

Property	Pattern	Type	Deprecated	Definition	Title/Description
- data	No	Combination	No	-	-
- var	No	string	No	-	-
- 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]
Default	`null`

Any of(Option)
item 0
item 1
item 2

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]

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]

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]

	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]
Default	`"loop_item"`

1.2.1.2.2. Property `root > .* > tree > tree items > oneOf > item 1 > rule`

Type	`combining`
Additional properties	[Any type: allowed]
Default	`".*"`

One of(Option)
item 0
item 1

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]

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]

1.2.1.2.3. Property `root > .* > tree > tree items > oneOf > item 1 > strategy`

Type	`string`
Additional properties	[Any type: allowed]
Default	`"schema"`

1.2.1.2.4. Property `root > .* > tree > tree items > oneOf > item 1 > trace`

Type	`boolean`
Additional properties	[Any type: allowed]
Default	`false`

1.2.1.2.5. Property `root > .* > tree > tree items > oneOf > item 1 > explain`

Type	`boolean`
Additional properties	[Any type: allowed]
Default	`false`

1.3. [Optional] Property `root > .* > rules`

Type	`array`
Additional properties	[Any type: 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 on 2022-01-15 at 17:47:14 -0500