Update schema descriptions

aristanetworks · Oct 2, 2024 · 2e78278 · 2e78278
1 parent 799509f
commit 2e78278
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 4 deletions.
diff --git a/...ions/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-settings.md b/...ions/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-settings.md
diff --git a/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml b/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml
diff --git a/python-avd/pyavd/_eos_designs/schema/schema_fragments/defs_network_services.schema.yml b/python-avd/pyavd/_eos_designs/schema/schema_fragments/defs_network_services.schema.yml
@@ -425,7 +425,17 @@ $defs:
                     max: 2100
                   loopback_description:
                     type: str
-                    description: Provide a custom description for loopback interface.
+                    # TODO: Insert link to format string syntax article.
+                    description: |-
+                      Provide a custom description or description template to be used on the VRF diagnostic loopback interface.
+                      This can be a template using the format string syntax.
+                      The available template fields are:
+                        - `interface`: The Loopback interface name.
+                        - `vrf`: The VRF name.
+                        - `tenant`: The tenant name.
+
+                      The default description is set by `default_vrf_diag_loopback_description`.
+                      By default the description is templated from the VRF name.
                   loopback_ip_range:
                     type: str
                     description: |