Skip to content

Commit 96951b7

Browse files
authored
Jira source connector: the 'is cloud' setting is now reserved for future use (#604)
1 parent 159cef9 commit 96951b7

File tree

7 files changed

+22
-69
lines changed

7 files changed

+22
-69
lines changed

snippets/general-shared-text/jira-api-placeholders.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,10 @@
55
- `<token>` (_required_ for personal access token authentication): The personal access token of the Jira user.
66
- `<project-id>`: The ID of a target project in Jira to access.
77
- `<board-id>`: The ID of a target board in Jira to access.
8-
- `<issue-id>`: The ID of a target issue in Jira to access.
8+
- `<issue-id>`: The ID of a target issue in Jira to access.
9+
10+
<Warning>
11+
Setting `cloud` to `true` is reserved for future use.
12+
13+
Do not set `cloud` to `true`. Doing so could lead to unexpected results or failures.
14+
</Warning>

snippets/general-shared-text/jira-cli-api.mdx

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,14 @@ The following environment variables:
2727

2828
- `JIRA_PERSONAL_ACCESS_TOKEN` - The user's personal access token (PAT), represented by `--token` (CLI) or `token` (Python).
2929

30-
Also:
30+
Also, to process specific projects, boards, or issues, use:
3131

32-
- For Jira Cloud, you must specify `--cloud` (CLI) or set `cloud` to `True` (Python).
33-
- For Jira Data Center, you can specify `--no-cloud` (CLI) or set `cloud` to `False` (Python). This is the default if not otherwise specified.
34-
- To process specific projects, boards, or issues, use:
32+
- `--projects` with a comma-delimited list of target project IDs (CLI) or `project` with an array of target project IDs (Python).
33+
- `--boards` with a comma-delmited list of target board IDs (CLI) or `boards` with an array of target board IDs (Python).
34+
- `--issues` with a comma-delimited list of target issue IDs (CLI) or `issues` with an array of target issue IDs (Python).
3535

36-
- `--projects` with a comma-delimited list of target project IDs (CLI) or `project` with an array of target project IDs (Python).
37-
- `--boards` with a comma-delmited list of target board IDs (CLI) or `boards` with an array of target board IDs (Python).
38-
- `--issues` with a comma-delimited list of target issue IDs (CLI) or `issues` with an array of target issue IDs (Python).
36+
<Warning>
37+
Specifying `--cloud` (CLI) and setting `cloud` to `True` (Python) are reserved for future use.
38+
39+
Do not specify `--cloud` (CLI) or set `cloud` to `True` (Python). Doing so could lead to unexpected results or failures.
40+
</Warning>

snippets/general-shared-text/jira-platform.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,8 @@ Fill in the following fields:
88
- **Personal Access Token** (_required_ for personal access token authentication): The personal access token of the Jira user.
99
- **Projects**: A comma-separated list of IDs of the target projects in Jira to access.
1010
- **Boards**: A comma-separated list of IDs of the target boards in Jira to access.
11-
- **Issues**: A comma-separated list of IDs of the target issues in Jira to access.
11+
- **Issues**: A comma-separated list of IDs of the target issues in Jira to access.
12+
13+
<Warning>
14+
The **Cloud** check box is reserved for future use. This box must always remain unchecked. Checking this box could lead to unexpected results or failures.
15+
</Warning>

snippets/source_connectors/jira.py.mdx

Lines changed: 0 additions & 27 deletions
This file was deleted.

snippets/source_connectors/jira.sh.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ unstructured-ingest \
99
--username $JIRA_USERNAME \
1010
--password $JIRA_PASSWORD_OR_API_TOKEN \ # Password or API token authentication.
1111
--token $JIRA_PERSONAL_ACCESS_TOKEN \ # Personal access token authentication only.
12-
--cloud \ # True for Jira Cloud.
13-
--no-cloud \ # For Jira Data Center (default).
1412
--output-dir $LOCAL_FILE_OUTPUT_DIR \
1513
--chunking-strategy by_title \
1614
--embedding-provider huggingface \

snippets/source_connectors/jira.v2.py.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ if __name__ == "__main__":
4040
# token=os.getenv("JIRA_PERSONAL_ACCES_TOKEN") # Personal access token authentication only.
4141
),
4242
url=os.getenv("JIRA_URL"),
43-
username=os.getenv("JIRA_USERNAME"), # For password or API token authentication.
44-
cloud=True # True for Jira Cloud, False (default) for Jira Data Center.
43+
username=os.getenv("JIRA_USERNAME") # For password or API token authentication.
4544
),
4645
partitioner_config=PartitionerConfig(
4746
partition_by_api=True,

snippets/source_connectors/jira_api.py.mdx

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)