Skip to content

Commit d026a38

Browse files
committed
Add table structure to ref
1 parent 76125f6 commit d026a38

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

doc/reference/reference_lua/config/utils_schema.rst

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,12 @@ Functions
651651
652652
See also: :ref:`schema_node_object <config-utils-schema_node_object>`, :ref:`schema_node_annotation <config-utils-schema_node_annotation>`.
653653

654-
:return: the created schema node
654+
:return: the created array node as a table with the following fields:
655+
656+
- ``type``: ``array``
657+
- ``items``: a table describing an array item as a schema node
658+
- annotations, if provided in ``array_def``
659+
655660
:rtype: table
656661

657662
**See also:** :ref:`config_utils_schema_nodes_array`
@@ -665,7 +670,12 @@ Functions
665670
:param table allowed_values: a list of enum members -- values allowed for the node
666671
:param table annotations: annotations (see :ref:`schema_node_annotation <config-utils-schema_node_annotation>`)
667672

668-
:return: the created schema node
673+
:return: the created scalar node as a table with the following fields:
674+
675+
- ``type``: ``string``
676+
- ``allowed_values``: allowed node values
677+
- annotations, if ``annotations`` is provided
678+
669679
:rtype: table
670680

671681
**See also:** :ref:`config_utils_schema_nodes_scalar`
@@ -726,7 +736,13 @@ Functions
726736
727737
See also: :ref:`schema_node_object <config-utils-schema_node_object>`, :ref:`schema_node_annotation <config-utils-schema_node_annotation>`.
728738

729-
:return: the created schema node
739+
:return: the created map node as a table with the following fields:
740+
741+
- ``type``: ``map``
742+
- ``key``: map key type
743+
- ``value``: map value type
744+
- annotations, if provided in ``map_def``
745+
730746
:rtype: table
731747

732748
**See also:** :ref:`config_utils_schema_nodes_map`
@@ -771,7 +787,12 @@ Functions
771787

772788
:param table annotations: annotations (see :ref:`config_utils_schema_annotation`)
773789

774-
:return: the created schema node
790+
:return: the created record node as a table with the following fields:
791+
792+
- ``type``: ``record``
793+
- ``fields``: a table describing the record fields
794+
- annotations, if provided
795+
775796
:rtype: table
776797

777798
**See also:** :ref:`config_utils_schema_nodes_record`
@@ -785,7 +806,11 @@ Functions
785806
:param string type: data type (see :ref:`config_utils_schema_data_types`)
786807
:param table annotations: annotations (see :ref:`config_utils_schema_annotation`)
787808

788-
:return: the created schema node
809+
:return: the created scalar node as a table with the following fields:
810+
811+
- ``type``: the node type (see :ref:`config_utils_schema_data_types`)
812+
- annotations, if provided
813+
789814
:rtype: table
790815

791816
**See also:** :ref:`config_utils_schema_nodes_scalar`

0 commit comments

Comments
 (0)