add some seealso links for vault_kv2_write (#360)

* add some seealso links for vault_kv2_write * fqcn references * fix regression from bad search/replace
ansible-collections · Mar 27, 2023 · 06c6fc9 · 06c6fc9
1 parent 214aa1b
commit 06c6fc9
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/plugins/lookup/vault_write.py b/plugins/lookup/vault_write.py
@@ -18,6 +18,7 @@
     - Performs a generic write operation against a given path in HashiCorp Vault, returning any output.
   seealso:
     - module: community.hashi_vault.vault_write
+    - module: community.hashi_vault.vault_kv2_write
     - ref: community.hashi_vault.vault_read lookup <ansible_collections.community.hashi_vault.vault_read_lookup>
       description: The official documentation for the C(community.hashi_vault.vault_read) lookup plugin.
     - module: community.hashi_vault.vault_read

diff --git a/plugins/modules/vault_kv2_delete.py b/plugins/modules/vault_kv2_delete.py
@@ -29,6 +29,7 @@
       - Consider using M(community.hashi_vault.vault_kv2_get) to verify the existence of the secret first.
 seealso:
   - module: community.hashi_vault.vault_kv2_get
+  - module: community.hashi_vault.vault_kv2_write
   - name: KV2 Secrets Engine
     description: Documentation for the Vault KV secrets engine, version 2.
     link: https://www.vaultproject.io/docs/secrets/kv/kv-v2

diff --git a/plugins/modules/vault_kv2_get.py b/plugins/modules/vault_kv2_get.py
@@ -22,6 +22,7 @@
   - ref: community.hashi_vault.vault_kv2_get lookup <ansible_collections.community.hashi_vault.vault_kv2_get_lookup>
     description: The official documentation for the C(community.hashi_vault.vault_kv2_get) lookup plugin.
   - module: community.hashi_vault.vault_kv1_get
+  - module: community.hashi_vault.vault_kv2_write
   - name: KV2 Secrets Engine
     description: Documentation for the Vault KV secrets engine, version 2.
     link: https://www.vaultproject.io/docs/secrets/kv/kv-v2

diff --git a/plugins/modules/vault_kv2_write.py b/plugins/modules/vault_kv2_write.py
@@ -19,6 +19,15 @@
 requirements:
   - C(hvac) (L(Python library,https://hvac.readthedocs.io/en/stable/overview.html))
   - For detailed requirements, see R(the collection requirements page,ansible_collections.community.hashi_vault.docsite.user_guide.requirements).
+seealso:
+  - module: community.hashi_vault.vault_write
+  - module: community.hashi_vault.vault_kv2_get
+  - module: community.hashi_vault.vault_kv2_delete
+  - ref: community.hashi_vault.vault_write lookup <ansible_collections.community.hashi_vault.vault_write_lookup>
+    description: The official documentation for the C(community.hashi_vault.vault_write) lookup plugin.
+  - name: KV2 Secrets Engine
+    description: Documentation for the Vault KV secrets engine, version 2.
+    link: https://www.vaultproject.io/docs/secrets/kv/kv-v2
 extends_documentation_fragment:
   - community.hashi_vault.attributes
   - community.hashi_vault.attributes.action_group