This is an automated email from the ASF dual-hosted git repository.
corgy pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new 8adf1ca3a7 [Doc][zh-CN] Add Jira connector Chinese documentation
(#9236)
8adf1ca3a7 is described below
commit 8adf1ca3a74a4baff6cbf371e1dde7cd11b75172
Author: RongHaHa <[email protected]>
AuthorDate: Tue Apr 29 17:56:02 2025 +0800
[Doc][zh-CN] Add Jira connector Chinese documentation (#9236)
---
docs/zh/connector-v2/source/Jira.md | 303 ++++++++++++++++++++++++++++++++++++
1 file changed, 303 insertions(+)
diff --git a/docs/zh/connector-v2/source/Jira.md
b/docs/zh/connector-v2/source/Jira.md
new file mode 100644
index 0000000000..d7b7cf1f3d
--- /dev/null
+++ b/docs/zh/connector-v2/source/Jira.md
@@ -0,0 +1,303 @@
+import ChangeLog from '../changelog/connector-http-jira.md';
+
+# Jira
+
+> Jira 源连接器
+
+## 描述
+
+从 Jira 读取数据。
+
+## 关键特性
+
+- [x] [批处理](../../concept/connector-v2-features.md)
+- [ ] [流处理](../../concept/connector-v2-features.md)
+- [ ] [精确一次](../../concept/connector-v2-features.md)
+- [ ] [列投影](../../concept/connector-v2-features.md)
+- [ ] [并行度](../../concept/connector-v2-features.md)
+- [ ] [支持用户定义的分片](../../concept/connector-v2-features.md)
+
+## 选项
+
+| 名称 | 类型 | 必需 | 默认值 |
+|-----------------------------|---------|----------|---------------|
+| url | String | 是 | - |
+| email | String | 是 | - |
+| api_token | String | 是 | - |
+| method | String | 否 | get |
+| schema.fields | Config | 否 | - |
+| format | String | 否 | json |
+| params | Map | 否 | - |
+| body | String | 否 | - |
+| json_field | Config | 否 | - |
+| content_json | String | 否 | - |
+| poll_interval_millis | int | 否 | - |
+| retry | int | 否 | - |
+| retry_backoff_multiplier_ms | int | 否 | 100 |
+| retry_backoff_max_ms | int | 否 | 10000 |
+| enable_multi_lines | boolean | 否 | false |
+| common-options | config | 否 | - |
+
+### url [String]
+
+http 请求 url
+
+### email [String]
+
+Jira 邮件
+
+### api_token [String]
+
+Jira API 接口
+
+https://id.atlassian.com/manage-profile/security/api-tokens
+
+### method [String]
+
+http 请求方法。目前支持 'GET'和 'POST'。
+
+### params [Map]
+
+http 参数
+
+### body [String]
+
+http 请求体
+
+### poll_interval_millis [int]
+
+流程下请求 API 的间隔时间（毫秒）。
+
+### retry [int]
+
+请求失败 (`IOException`)时最大重试次数
+
+### retry_backoff_multiplier_ms [int]
+
+重试退避时间倍数（毫秒）。
+
+### retry_backoff_max_ms [int]
+
+重试退避最大时间（毫秒）。
+
+### format [String]
+
+上游数据的格式，现在仅支持`json` `text`, 默认是 `json`.
+
+若你的数据格式为 `json`, 需同时配置 schema 选项，例如：
+
+上游数据如下：
+
+```json
+{
+ "code": 200,
+ "data": "get success",
+ "success": true
+}
+```
+
+您应该配置 schema 为以下内容：
+
+```hocon
+
+schema {
+ fields {
+ code = int
+ data = string
+ success = boolean
+ }
+}
+
+```
+
+连接器将生成如下数据：
+
+| code | data | success |
+|------|-------------|---------|
+| 200 | get success | true |
+
+若你设置格式为 `text`，连接器不会对上游数据做出任何改变，示例：
+
+上游数据如下：
+
+```json
+{
+ "code": 200,
+ "data": "get success",
+ "success": true
+}
+```
+
+连接器将生成如下数据：
+
+| content |
+|----------------------------------------------------------|
+| {"code": 200, "data": "get success", "success": true} |
+
+### schema [Config]
+
+#### fields [Config]
+
+上游数据的字段定义。
+
+### content_json [String]
+
+该参数可用于提取一些 json 数据。如果你只需要 “book” 部分的数据，可以配置 `content_field = "$.store.book.*"`.
+
+如果你的返回数据如下所示：
+
+```json
+{
+ "store": {
+ "book": [
+ {
+ "category": "reference",
+ "author": "Nigel Rees",
+ "title": "Sayings of the Century",
+ "price": 8.95
+ },
+ {
+ "category": "fiction",
+ "author": "Evelyn Waugh",
+ "title": "Sword of Honour",
+ "price": 12.99
+ }
+ ],
+ "bicycle": {
+ "color": "red",
+ "price": 19.95
+ }
+ },
+ "expensive": 10
+}
+```
+
+你可以配置 `content_field = "$.store.book.*"` 并且结果返回如下：
+
+```json
+[
+ {
+ "category": "reference",
+ "author": "Nigel Rees",
+ "title": "Sayings of the Century",
+ "price": 8.95
+ },
+ {
+ "category": "fiction",
+ "author": "Evelyn Waugh",
+ "title": "Sword of Honour",
+ "price": 12.99
+ }
+]
+```
+
+然后你可以通过更简单的 schema 配置获取所需的结果，例如：
+
+```hocon
+Http {
+ url = "http://mockserver:1080/contentjson/mock";
+ method = "GET"
+ format = "json"
+ content_field = "$.store.book.*"
+ schema = {
+ fields {
+ category = string
+ author = string
+ title = string
+ price = string
+ }
+ }
+}
+```
+
+示例：
+
+- 测试数据可参考此链接：
[mockserver-config.json](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/mockserver-config.json)
+-
任务配置示例可参考此链接：[http_contentjson_to_assert.conf](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/http_contentjson_to_assert.conf).
+
+### json_field [Config]
+
+该参数用于帮助你配置 schema，因此必须与 schema 一起使用。
+
+如果你的数据如下所示：
+
+```json
+{
+ "store": {
+ "book": [
+ {
+ "category": "reference",
+ "author": "Nigel Rees",
+ "title": "Sayings of the Century",
+ "price": 8.95
+ },
+ {
+ "category": "fiction",
+ "author": "Evelyn Waugh",
+ "title": "Sword of Honour",
+ "price": 12.99
+ }
+ ],
+ "bicycle": {
+ "color": "red",
+ "price": 19.95
+ }
+ },
+ "expensive": 10
+}
+```
+
+你可以通过如下任务配置获取 “book” 部分的内容：
+
+```hocon
+source {
+ Http {
+ url = "http://mockserver:1080/jsonpath/mock";
+ method = "GET"
+ format = "json"
+ json_field = {
+ category = "$.store.book[*].category"
+ author = "$.store.book[*].author"
+ title = "$.store.book[*].title"
+ price = "$.store.book[*].price"
+ }
+ schema = {
+ fields {
+ category = string
+ author = string
+ title = string
+ price = string
+ }
+ }
+ }
+}
+```
+
+- 测试数据可参考此链接：
[mockserver-config.json](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/mockserver-config.json)
+- 任务配置示例可参考此链接：
[http_jsonpath_to_assert.conf](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/http_jsonpath_to_assert.conf).
+
+### 通用配置
+
+源插件通用参数，请参考 [常用选项](../source-common-options.md) 获取详细说明
+
+## 示例
+
+```hocon
+Jira {
+ url = "https://liugddx.atlassian.net/rest/api/3/search";
+ email = "[email protected]"
+ api_token = "xxx"
+ schema {
+ fields {
+ expand = string
+ startAt = bigint
+ maxResults = int
+ total = int
+ }
+ }
+}
+```
+
+## 变更日志
+
+<ChangeLog />
