Skip to content

Commit

Permalink
Fix
Browse files Browse the repository at this point in the history
  • Loading branch information
p7nov committed Oct 16, 2024
1 parent df97372 commit 36cb3c3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
6 changes: 6 additions & 0 deletions doc/reference/configuration/configuration_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3912,6 +3912,12 @@ This section describes configuration parameters related to :ref:`application rol

See also: :ref:`configuration_application_roles`

.. tip::

The :ref:`experimental.config.utils.schema <config_utils_schema_module>`
built-in module provides an API for managing user-defined configurations
of applications (``app.cfg``) and roles (``roles_cfg``).

|
| Type: map
| Default: nil
Expand Down
8 changes: 4 additions & 4 deletions doc/reference/reference_lua/config/utils_schema.rst
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ User-defined methods

A schema can implement custom logic with *methods* -- user-defined functions that can be called on this schema.

For example, this schema has a method that returns its fields merged in a URI string:
For example, this schema has the ``format`` method that returns its fields merged in a URI string:

.. literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_methods/http_api.lua
:language: lua
Expand Down Expand Up @@ -451,7 +451,7 @@ When writing roles, call this function inside the :ref:`role validation function
Getting configuration values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To get configuration values, use the schema's :ref:`get() <config-schema_object-get>` method.
To get configuration values, use the schema object's :ref:`get() <config-schema_object-get>` method.
The function takes the configuration and the full path to the node as arguments:

.. literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_record_hierarchy/http_api.lua
Expand Down Expand Up @@ -941,7 +941,7 @@ schema_object

.. important::

The method doesn't return records nodes.
The method doesn't return record nodes.

:return: a luafun iterator

Expand Down Expand Up @@ -1014,7 +1014,7 @@ schema_object

Schema nodes hierarchy.

**See also:** ``schema_node_object``
**See also:** :ref:`config-utils-schema_node_object`


.. _config-utils-schema_node_annotation:
Expand Down

0 comments on commit 36cb3c3

Please sign in to comment.