Skip to content

Commit 88a23fe

Browse files
authored
Jira source connector: restore 'is cloud' setting (#618)
1 parent ddbf7a4 commit 88a23fe

File tree

7 files changed

+13
-20
lines changed

7 files changed

+13
-20
lines changed

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,4 @@
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.
88
- `<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>
9+
- Set `cloud` to `true` to specify using Jira Cloud or `false` to specify using Jira Data Center. The default is to use Jira Data Center.

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

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,5 @@ Also, to process specific projects, boards, or issues, use:
3232
- `--projects` with a comma-delimited list of target project IDs (CLI) or `project` with an array of target project IDs (Python).
3333
- `--boards` with a comma-delmited list of target board IDs (CLI) or `boards` with an array of target board IDs (Python).
3434
- `--issues` with a comma-delimited list of target issue IDs (CLI) or `issues` with an array of target issue IDs (Python).
35-
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>
35+
- `--cloud` (CLI) or `cloud=True` (Python) to specify using Jira Cloud. The default is to use Jira Data Center.
36+
- `--no-cloud` (CLI) or `cloud=False` (Python) to specify using Jira Data Center. This is the default behavior.

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@ Fill in the following fields:
66
- **Password** (_required_ for password authentication): The password of the Jira user.
77
- **API Token** (_required_ for API token authentication): The API token of the Jira user.
88
- **Personal Access Token** (_required_ for personal access token authentication): The personal access token of the Jira user.
9+
- **Cloud**: Check this box if you are using Jira Cloud. The default is unchecked to use Jira Data Center.
910
- **Projects**: A comma-separated list of IDs of the target projects in Jira to access.
1011
- **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.
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>
12+
- **Issues**: A comma-separated list of IDs of the target issues in Jira to access.

snippets/source_connectors/jira.sh.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ 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 \ # For Jira Cloud.
13+
--no-cloud \ # For Jira Data Center (default).
1214
--output-dir $LOCAL_FILE_OUTPUT_DIR \
1315
--chunking-strategy by_title \
1416
--embedding-provider huggingface \

snippets/source_connectors/jira.v2.py.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ 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.
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.
4445
),
4546
partitioner_config=PartitionerConfig(
4647
partition_by_api=True,

snippets/source_connectors/jira_rest_create.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ curl --request 'POST' --location \
2929
"issues": [
3030
"<issue-id>",
3131
"<issue-id>"
32-
]
32+
],
33+
"cloud": <true|false>
3334
}
3435
}'
3536
```

snippets/source_connectors/jira_sdk.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien
3636
issues=[
3737
"<issue-id>",
3838
"<issue-id>"
39-
]
39+
],
40+
cloud=<True|False>
4041
)
4142
)
4243
)

0 commit comments

Comments
 (0)