Fix schema desc typo

aristanetworks · Jul 2, 2024 · ba3298b · ba3298b
1 parent 142707d
commit ba3298b
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/ospf-settings.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/ospf-settings.md
@@ -13,7 +13,7 @@
     | [<samp>&nbsp;&nbsp;message_digest_keys</samp>](## "underlay_ospf_authentication.message_digest_keys") | List, items: Dictionary |  |  |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;id</samp>](## "underlay_ospf_authentication.message_digest_keys.[].id") | Integer |  |  |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;hash_algorithm</samp>](## "underlay_ospf_authentication.message_digest_keys.[].hash_algorithm") | String |  | `sha512` | Valid Values:<br>- <code>md5</code><br>- <code>sha1</code><br>- <code>sha256</code><br>- <code>sha384</code><br>- <code>sha512</code> |  |
-    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key</samp>](## "underlay_ospf_authentication.message_digest_keys.[].key") | String |  |  |  | Key password<br>Only plaintext passwords are supported here as the password will ned to be encrypted for every underlay interface.<br>To protect the password at rest it is recommended to make use of Ansible Vault or similar.<br> |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key</samp>](## "underlay_ospf_authentication.message_digest_keys.[].key") | String |  |  |  | Key password.<br>Only plaintext passwords are supported here as the password will need to be encrypted for every underlay interface.<br>To protect the password at rest it is recommended to make use of Ansible Vault or similar.<br> |
     | [<samp>underlay_ospf_bfd_enable</samp>](## "underlay_ospf_bfd_enable") | Boolean |  | `False` |  |  |
     | [<samp>underlay_ospf_max_lsa</samp>](## "underlay_ospf_max_lsa") | Integer |  | `12000` |  |  |
     | [<samp>underlay_ospf_process_id</samp>](## "underlay_ospf_process_id") | Integer |  | `100` |  |  |
@@ -28,8 +28,8 @@
         - id: <int>
           hash_algorithm: <str; "md5" | "sha1" | "sha256" | "sha384" | "sha512"; default="sha512">
 
-          # Key password
-          # Only plaintext passwords are supported here as the password will ned to be encrypted for every underlay interface.
+          # Key password.
+          # Only plaintext passwords are supported here as the password will need to be encrypted for every underlay interface.
           # To protect the password at rest it is recommended to make use of Ansible Vault or similar.
           key: <str>
     underlay_ospf_bfd_enable: <bool; default=False>

diff --git a/python-avd/pyavd/_eos_designs/schema/eos_designs.jsonschema.json b/python-avd/pyavd/_eos_designs/schema/eos_designs.jsonschema.json
@@ -60321,7 +60321,7 @@
               },
               "key": {
                 "type": "string",
-                "description": "Key password\nOnly plaintext passwords are supported here as the password will ned to be encrypted for every underlay interface.\nTo protect the password at rest it is recommended to make use of Ansible Vault or similar.\n",
+                "description": "Key password.\nOnly plaintext passwords are supported here as the password will need to be encrypted for every underlay interface.\nTo protect the password at rest it is recommended to make use of Ansible Vault or similar.\n",
                 "title": "Key"
               }
             },

diff --git a/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml b/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml
@@ -4054,9 +4054,9 @@ keys:
               default: sha512
             key:
               type: str
-              description: 'Key password
+              description: 'Key password.
 
-                Only plaintext passwords are supported here as the password will ned
+                Only plaintext passwords are supported here as the password will need
                 to be encrypted for every underlay interface.
 
                 To protect the password at rest it is recommended to make use of Ansible

diff --git a/...on-avd/pyavd/_eos_designs/schema/schema_fragments/underlay_ospf_authentication_schema.yml b/...on-avd/pyavd/_eos_designs/schema/schema_fragments/underlay_ospf_authentication_schema.yml
@@ -35,6 +35,6 @@ keys:
             key:
               type: str
               description: |
-                Key password
-                Only plaintext passwords are supported here as the password will ned to be encrypted for every underlay interface.
+                Key password.
+                Only plaintext passwords are supported here as the password will need to be encrypted for every underlay interface.
                 To protect the password at rest it is recommended to make use of Ansible Vault or similar.