Schemas#

Index

How to read these schemas?#

Configurations files in OrangeQS juice are stored as TOML files. The schemas are shown are documented by their keys. The example below shows how the different types of keys map to TOML.

dummy.toml#

An example configuration file. The header dummy.toml means that the contents of this file are stored in dummy.toml or dummy.d/<descriptive name>.toml. See How configurations are stored and loaded for more information.

option_a#

Type: string. Default: 'some_value'

An example option with of type string, including a default value. The header option_a corresponds to the key of this configuration option. To configure this option in TOML, you would add the following:

option_a = "my_own_value"

category_b.option_b#

Type: int

The header category_b.option_b corresponds to the key of this configuration option. This means that this option is key option_b of the table category_b, as seen below:

[category_b]
option_b = 3

list_c#

Type: list[integer]

A list of integers. This means that this option should be a list under the key list_c:

list_c = [1, 2, 3]

mapping_d#

Type: dict[string, string]

A dictionary that maps from strings to strings. This corresponds to the following TOML:

[mapping_d]
from = "to"
another_from = "another_to"
arbitrary = "value"

mapping_e.{key}.option_e#

Type: int

A mapping from strings to a dictionary. The dictionary has a single option option_e. This corresponds to the following TOML:

[mapping_e.my_key]
option_e = 5

[mapping_e.another_key]
option_e = 3

list_f[].option_f#

Type: int

A list of dictionaries. The dictionary has a single option option_f. This corresponds to the following TOML:

[[list_f]]
option_f = 2

[[list_f]]
option_f = 1