Feat(eos_designs): Enforce unicity of region IDs and per-region site …

…IDs for CV Pathfinder
aristanetworks · Jun 19, 2024 · a1f30e4 · a1f30e4
1 parent faa4684
commit a1f30e4
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml b/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml
@@ -701,6 +701,8 @@ keys:
     description: Define the CV Pathfinder hierarchy.
     type: list
     primary_key: name
+    unique_keys:
+    - id
     items:
       type: dict
       $ref: eos_cli_config_gen#/keys/router_adaptive_virtual_topology/keys/region
@@ -719,6 +721,8 @@ keys:
           description: All sites are placed in a default zone "<region_name>-ZONE"
             with ID 1.
           primary_key: name
+          unique_keys:
+          - id
           items:
             type: dict
             $ref: eos_cli_config_gen#/keys/router_adaptive_virtual_topology/keys/site

diff --git a/python-avd/pyavd/_eos_designs/schema/schema_fragments/cv_pathfinder_regions.schema.yml b/python-avd/pyavd/_eos_designs/schema/schema_fragments/cv_pathfinder_regions.schema.yml
@@ -12,6 +12,8 @@ keys:
     description: Define the CV Pathfinder hierarchy.
     type: list
     primary_key: name
+    unique_keys:
+      - id
     items:
       type: dict
       $ref: "eos_cli_config_gen#/keys/router_adaptive_virtual_topology/keys/region"
@@ -31,6 +33,8 @@ keys:
           description: |-
             All sites are placed in a default zone "<region_name>-ZONE" with ID 1.
           primary_key: name
+          unique_keys:
+            - id
           items:
             type: dict
             $ref: "eos_cli_config_gen#/keys/router_adaptive_virtual_topology/keys/site"

diff --git a/python-avd/pyavd/_schema/avd_meta_schema.json b/python-avd/pyavd/_schema/avd_meta_schema.json
@@ -216,7 +216,7 @@
                         },
                         "unique_keys": {
                             "type": "array",
-                            "description": "List of types to auto-convert from.\nFor 'list of dicts' auto-conversion is supported from 'dict' if 'primary_key' is set on the list schema\nFor other list item types conversion from dict will use the keys as list items.",
+                            "description": "List of keys or dot-notation path keys that must be unique in addition to primary_key.",
                             "items": {
                                 "type": "string",
                                 "$comment": "The regex here matches valid key names",