From 36e8653cf73135b0a80a8dd94543a11403c871d0 Mon Sep 17 00:00:00 2001
From: Chris Evich <1183438+cevich@users.noreply.github.com>
Date: Mon, 5 Jun 2023 15:18:12 -0400
Subject: [PATCH] Minor bitwarden plugin req. docs addition (#6613)

The Bitwarden CLI requires a `login` followed by an `unlock` operation.
The later will display a message regarding setting (and exporting) the
`$BW_SESSION` env. var. When using the `bitwarden` lookup plugin, having
the env. var. set and available (exported) to Ansible is critical.
Without it, the plugin will simply return the error:

`Bitwarden Vault locked. Run 'bw unlock'.`

Make this clearer in the requirement documentation.

Signed-off-by: Chris Evich <cevich@redhat.com>
---
 plugins/lookup/bitwarden.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/plugins/lookup/bitwarden.py b/plugins/lookup/bitwarden.py
index 389fa475bd..27de1afe60 100644
--- a/plugins/lookup/bitwarden.py
+++ b/plugins/lookup/bitwarden.py
@@ -12,6 +12,8 @@ DOCUMENTATION = """
     requirements:
       - bw (command line utility)
       - be logged into bitwarden
+      - bitwarden vault unlocked
+      - C(BW_SESSION) environment variable set
     short_description: Retrieve secrets from Bitwarden
     version_added: 5.4.0
     description: