Schema validation - rename samples

tarantool · Sep 12, 2024 · ae3b41b · ae3b41b
1 parent 01cbe38
commit ae3b41b
Show file tree

Hide file tree

Showing 28 changed files with 41 additions and 43 deletions.
diff --git a/...plication_validate_cfg_record/config.yaml → ...led/config_schema_annotations/config.yaml b/...plication_validate_cfg_record/config.yaml → ...led/config_schema_annotations/config.yaml
diff --git a/...idate_cfg_record_annotations/http_api.lua → ...ed/config_schema_annotations/http_api.lua b/...idate_cfg_record_annotations/http_api.lua → ...ed/config_schema_annotations/http_api.lua
diff --git a/...n_validate_cfg_array_record/instances.yml → ...d/config_schema_annotations/instances.yml b/...n_validate_cfg_array_record/instances.yml → ...d/config_schema_annotations/instances.yml
diff --git a/...e_cfg_record_computed_annotations/api.lua → ...onfig_schema_computed_annotations/api.lua b/...e_cfg_record_computed_annotations/api.lua → ...onfig_schema_computed_annotations/api.lua
diff --git a/...g_record_computed_annotations/config.yaml → ...g_schema_computed_annotations/config.yaml b/...g_record_computed_annotations/config.yaml → ...g_schema_computed_annotations/config.yaml
diff --git a/...ication_validate_cfg_record/instances.yml → ...schema_computed_annotations/instances.yml b/...ication_validate_cfg_record/instances.yml → ...schema_computed_annotations/instances.yml
diff --git a/...lidate_cfg_record_annotations/config.yaml → ...enabled/config_schema_fromenv/config.yaml b/...lidate_cfg_record_annotations/config.yaml → ...enabled/config_schema_fromenv/config.yaml
diff --git a/..._validate_cfg_record_fromenv/http_api.lua → ...nabled/config_schema_fromenv/http_api.lua b/..._validate_cfg_record_fromenv/http_api.lua → ...nabled/config_schema_fromenv/http_api.lua
diff --git a/...date_cfg_record_annotations/instances.yml → ...abled/config_schema_fromenv/instances.yml b/...date_cfg_record_annotations/instances.yml → ...abled/config_schema_fromenv/instances.yml
diff --git a/...n_validate_cfg_record_fromenv/config.yaml → ...enabled/config_schema_methods/config.yaml b/...n_validate_cfg_record_fromenv/config.yaml → ...enabled/config_schema_methods/config.yaml
diff --git a/..._validate_cfg_record_methods/http_api.lua → ...nabled/config_schema_methods/http_api.lua b/..._validate_cfg_record_methods/http_api.lua → ...nabled/config_schema_methods/http_api.lua
diff --git a/...record_computed_annotations/instances.yml → ...abled/config_schema_methods/instances.yml b/...record_computed_annotations/instances.yml → ...abled/config_schema_methods/instances.yml
diff --git a/...ion_validate_cfg_array_record/config.yaml → ...led/config_schema_nodes_array/config.yaml b/...ion_validate_cfg_array_record/config.yaml → ...led/config_schema_nodes_array/config.yaml
diff --git a/...on_validate_cfg_array_record/http-api.lua → ...ed/config_schema_nodes_array/http-api.lua b/...on_validate_cfg_array_record/http-api.lua → ...ed/config_schema_nodes_array/http-api.lua
diff --git a/...validate_cfg_record_fromenv/instances.yml → ...d/config_schema_nodes_array/instances.yml b/...validate_cfg_record_fromenv/instances.yml → ...d/config_schema_nodes_array/instances.yml
diff --git a/...ation_validate_cfg_record_map/config.yaml → ...abled/config_schema_nodes_map/config.yaml b/...ation_validate_cfg_record_map/config.yaml → ...abled/config_schema_nodes_map/config.yaml
diff --git a/...tion_validate_cfg_record_map/http_api.lua → ...bled/config_schema_nodes_map/http_api.lua b/...tion_validate_cfg_record_map/http_api.lua → ...bled/config_schema_nodes_map/http_api.lua
diff --git a/...lidate_cfg_record_hierarchy/instances.yml → ...led/config_schema_nodes_map/instances.yml b/...lidate_cfg_record_hierarchy/instances.yml → ...led/config_schema_nodes_map/instances.yml
diff --git a/...n_validate_cfg_record_methods/config.yaml → ...ed/config_schema_nodes_record/config.yaml b/...n_validate_cfg_record_methods/config.yaml → ...ed/config_schema_nodes_record/config.yaml
diff --git a/...lication_validate_cfg_record/http_api.lua → ...d/config_schema_nodes_record/http_api.lua b/...lication_validate_cfg_record/http_api.lua → ...d/config_schema_nodes_record/http_api.lua
diff --git a/...ion_validate_cfg_record_map/instances.yml → .../config_schema_nodes_record/instances.yml b/...ion_validate_cfg_record_map/instances.yml → .../config_schema_nodes_record/instances.yml
diff --git a/...validate_cfg_record_hierarchy/config.yaml → ...schema_nodes_record_hierarchy/config.yaml b/...validate_cfg_record_hierarchy/config.yaml → ...schema_nodes_record_hierarchy/config.yaml
diff --git a/...alidate_cfg_record_hierarchy/http_api.lua → ...chema_nodes_record_hierarchy/http_api.lua b/...alidate_cfg_record_hierarchy/http_api.lua → ...chema_nodes_record_hierarchy/http_api.lua
diff --git a/...validate_cfg_record_methods/instances.yml → ...hema_nodes_record_hierarchy/instances.yml b/...validate_cfg_record_methods/instances.yml → ...hema_nodes_record_hierarchy/instances.yml
diff --git a/...plication_validate_cfg_scalar/config.yaml → ...ed/config_schema_nodes_scalar/config.yaml b/...plication_validate_cfg_scalar/config.yaml → ...ed/config_schema_nodes_scalar/config.yaml
diff --git a/...lication_validate_cfg_scalar/http_api.lua → ...d/config_schema_nodes_scalar/http_api.lua b/...lication_validate_cfg_scalar/http_api.lua → ...d/config_schema_nodes_scalar/http_api.lua
diff --git a/...ication_validate_cfg_scalar/instances.yml → .../config_schema_nodes_scalar/instances.yml b/...ication_validate_cfg_scalar/instances.yml → .../config_schema_nodes_scalar/instances.yml
diff --git a/doc/reference/reference_lua/config/utils_schema.rst b/doc/reference/reference_lua/config/utils_schema.rst
@@ -26,14 +26,14 @@ Getting started with config.utils.schema
 
 Example config - scalar type:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/config.yaml
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_scalar/config.yaml
     :language: yaml
     :start-at: roles
     :dedent:
 
 1.  Load the module:
 
-    ..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/http_api.lua
+    ..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_scalar/http_api.lua
         :language: lua
         :start-at: config.utils.schema
         :end-at: config.utils.schema
@@ -42,7 +42,7 @@ Example config - scalar type:
 2.  Define a schema using :ref:`schema.new() <config-utils-schema-new>`.
     Example enum:
 
-    ..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/http_api.lua
+    ..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_scalar/http_api.lua
         :language: lua
         :start-at: local http_api_schema
         :end-before: local function validate
@@ -51,15 +51,15 @@ Example config - scalar type:
 3.  Validate config values using ``config.utils.schema.validate()``.
     For a role, inside the ``validate()`` func:
 
-    ..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/http_api.lua
+    ..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_scalar/http_api.lua
         :language: lua
         :start-at: local function validate
         :end-before: local function apply
         :dedent:
 
 4.  Get value. For a role, inside the ``apply()`` func:
 
-    ..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/http_api.lua
+    ..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_scalar/http_api.lua
         :language: lua
         :start-at: local function apply
         :end-before: local function stop
@@ -113,14 +113,14 @@ Scalar
 
 Example config - scalar type:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/config.yaml
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_scalar/config.yaml
     :language: yaml
     :start-at: roles
     :dedent:
 
 Schema definition:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_scalar/http_api.lua
     :language: lua
     :start-at: local http_api_schema
     :end-before: local function validate
@@ -137,21 +137,36 @@ Record
 
 Example config:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record/config.yaml
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_record/config.yaml
     :language: yaml
     :start-at: roles
     :dedent:
 
 Schema:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_record/http_api.lua
     :language: lua
     :start-at: local listen_address_schema
     :end-before: local function validate
     :dedent:
 
 
-TODO: add a sample with nested records. It can be used in the ``Processing configuration data`` section.
+Example config 2 (nested fields inside ``listen_address``):
+
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_record_hierarchy/config.yaml
+    :language: yaml
+    :start-at: roles
+    :dedent:
+
+Schema:
+
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_record_hierarchy/http_api.lua
+    :language: lua
+    :start-at: local listen_address_schema
+    :end-before: local function validate
+    :dedent:
+
+TODO: This sample can be used in the ``Processing configuration data`` section.
 
 
 
@@ -164,14 +179,14 @@ Also: :ref:`schema.set() <config-utils-schema-set>`
 
 Example config:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_array_record/config.yaml
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_array/config.yaml
     :language: yaml
     :start-at: roles
     :dedent:
 
 Schema:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_array_record/http-api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_array/http-api.lua
     :language: lua
     :start-at: local listen_address_schema
     :end-before: local function validate
@@ -184,14 +199,14 @@ Map
 
 Example config:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_map/config.yaml
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_map/config.yaml
     :language: yaml
     :start-at: roles
     :dedent:
 
 Schema:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_map/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_map/http_api.lua
     :language: lua
     :start-at: local listen_address_schema
     :end-before: local function validate
@@ -223,22 +238,22 @@ Annotations
 
 Example config:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_annotations/config.yaml
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_annotations/config.yaml
     :language: yaml
     :start-at: roles
     :dedent:
 
 Schema definition (``validate``, ``allowed_values``, ``default``):
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_annotations/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_annotations/http_api.lua
     :language: lua
     :start-at: local listen_address_schema
     :end-before: local function validate
     :dedent:
 
 Validate functions:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_annotations/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_annotations/http_api.lua
     :language: lua
     :start-at: local function validate_host
     :end-before: local listen_address_schema
@@ -254,7 +269,7 @@ User-defined annotations
 
 The ``env`` annotation:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_fromenv/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_fromenv/http_api.lua
     :language: lua
     :start-at: local listen_address_schema
     :end-before: local function collect_env_cfg
@@ -270,23 +285,23 @@ Computed annotations
 
 Schema node:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_computed_annotations/api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_computed_annotations/api.lua
     :language: lua
     :start-at: local listen_address
     :end-before: local http_listen_address_schema
     :dedent:
 
 Passes validation:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_computed_annotations/api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_computed_annotations/api.lua
     :language: lua
     :start-at: local http_listen_address_schema
     :end-before: local iproto_listen_address_schema
     :dedent:
 
 Raises an error:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_computed_annotations/api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_computed_annotations/api.lua
     :language: lua
     :start-at: local iproto_listen_address_schema
     :end-before: local function validate
@@ -301,14 +316,14 @@ User-defined methods
 
 Example config:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_methods/config.yaml
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_methods/config.yaml
     :language: yaml
     :start-at: roles
     :dedent:
 
 Schema:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_methods/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_methods/http_api.lua
     :language: lua
     :start-at: local listen_address_schema
     :end-before: local function validate
@@ -330,7 +345,7 @@ Validating configuration
 
 Role -- inside the ``validate()`` function:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_record_hierarchy/http_api.lua
     :language: lua
     :start-at: local function validate
     :end-before: local function apply
@@ -342,29 +357,12 @@ Role -- inside the ``validate()`` function:
 Getting configuration values
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Role -- inside the ``apply()`` function (scalar):
-
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_scalar/http_api.lua
-    :language: lua
-    :start-at: local function apply
-    :end-before: local function stop
-    :dedent:
-
-Record -- pass field names:
-
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_nodes_record/http_api.lua
     :language: lua
     :start-at: local function apply
     :end-before: local function stop
     :dedent:
 
-Array:
-
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_array_record/http-api.lua
-    :language: lua
-    :start-at: local function apply
-    :end-before: local function stop
-    :dedent:
 
 
 .. _config_utils_schema_transform_configuration:
@@ -383,7 +381,7 @@ Parsing environment variables
 
 Using :ref:`schema.fromenv() <config-utils-schema-fromenv>`:
 
-..  literalinclude:: /code_snippets/snippets/config/instances.enabled/application_validate_cfg_record_fromenv/http_api.lua
+..  literalinclude:: /code_snippets/snippets/config/instances.enabled/config_schema_fromenv/http_api.lua
     :language: lua
     :start-at: local listen_address_schema
     :end-before: local function validate