community: add support for 'cloud' parameter in JiraAPIWrapper (#23057)

- **Description:** Enhance JiraAPIWrapper to accept the 'cloud'
parameter through an environment variable. This update allows more
flexibility in configuring the environment for the Jira API.
 - **Twitter handle:** Andre_Q_Pereira

---------

Co-authored-by: André Quintino <andre.quintino@tui.com>
Co-authored-by: Eugene Yurtsev <eyurtsev@gmail.com>
Co-authored-by: Chester Curme <chester.curme@gmail.com>

docs/docs/integrations/toolkits/jira.ipynb

@@ -14,7 +14,8 @@
     "To use this tool, you must first set as environment variables:\n",
     "    JIRA_API_TOKEN\n",
     "    JIRA_USERNAME\n",
-    "    JIRA_INSTANCE_URL"
+    "    JIRA_INSTANCE_URL\n",
+    "    JIRA_CLOUD"
    ]
   },
   {
@@ -88,7 +89,8 @@
     "os.environ[\"JIRA_API_TOKEN\"] = \"abc\"\n",
     "os.environ[\"JIRA_USERNAME\"] = \"123\"\n",
     "os.environ[\"JIRA_INSTANCE_URL\"] = \"https://jira.atlassian.com\"\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"xyz\""
+    "os.environ[\"OPENAI_API_KEY\"] = \"xyz\"\n",
+    "os.environ[\"JIRA_CLOUD\"] = \"True\""
    ]
   },
   {

libs/community/langchain_community/tools/jira/tool.py

@@ -7,6 +7,7 @@ To use this tool, you must first set as environment variables:
     JIRA_API_TOKEN
     JIRA_USERNAME
     JIRA_INSTANCE_URL
+    JIRA_CLOUD
 
 Below is a sample script that uses the Jira tool:
 

libs/community/langchain_community/utilities/jira.py

@@ -15,6 +15,7 @@ class JiraAPIWrapper(BaseModel):
     jira_username: Optional[str] = None
     jira_api_token: Optional[str] = None
     jira_instance_url: Optional[str] = None
+    jira_cloud: Optional[bool] = None
 
     class Config:
         """Configuration for this pydantic object."""
@@ -39,6 +40,10 @@ class JiraAPIWrapper(BaseModel):
         )
         values["jira_instance_url"] = jira_instance_url
 
+        jira_cloud_str = get_from_dict_or_env(values, "jira_cloud", "JIRA_CLOUD")
+        jira_cloud = jira_cloud_str.lower() == "true"
+        values["jira_cloud"] = jira_cloud
+
         try:
             from atlassian import Confluence, Jira
         except ImportError:
@@ -51,21 +56,21 @@ class JiraAPIWrapper(BaseModel):
             jira = Jira(
                 url=jira_instance_url,
                 token=jira_api_token,
-                cloud=True,
+                cloud=jira_cloud,
             )
         else:
             jira = Jira(
                 url=jira_instance_url,
                 username=jira_username,
                 password=jira_api_token,
-                cloud=True,
+                cloud=jira_cloud,
             )
 
         confluence = Confluence(
             url=jira_instance_url,
             username=jira_username,
             password=jira_api_token,
-            cloud=True,
+            cloud=jira_cloud,
         )
 
         values["jira"] = jira

libs/community/tests/integration_tests/.env.example

@@ -34,6 +34,7 @@ PINECONE_ENVIRONMENT=us-west4-gcp
 # JIRA_API_TOKEN=your_jira_api_token_here
 # JIRA_USERNAME=your_jira_username_here
 # JIRA_INSTANCE_URL=your_jira_instance_url_here
+# JIRA_CLOUD=True
 
 
 # clickup