hailin0 commented on code in PR #5129:
URL: https://github.com/apache/seatunnel/pull/5129#discussion_r1288528754
##########
docs/en/connector-v2/source/MyHours.md:
##########
@@ -15,71 +17,103 @@ Used to read data from My Hours.
- [ ] [parallelism](../../concept/connector-v2-features.md)
- [ ] [support user-defined split](../../concept/connector-v2-features.md)
-## Options
-
-| name | type | required | default value |
-|-----------------------------|---------|----------|---------------|
-| url | String | Yes | - |
-| email | String | Yes | - |
-| password | String | Yes | - |
-| method | String | No | get |
-| schema | Config | No | - |
-| schema.fields | Config | No | - |
-| format | String | No | json |
-| params | Map | No | - |
-| body | String | No | - |
-| json_field | Config | No | - |
-| content_json | String | No | - |
-| poll_interval_ms | int | No | - |
-| retry | int | No | - |
-| retry_backoff_multiplier_ms | int | No | 100 |
-| retry_backoff_max_ms | int | No | 10000 |
-| enable_multi_lines | boolean | No | false |
-| common-options | config | No | - |
-
-### url [String]
-
-http request url
-
-### email [String]
-
-email for login
-
-### password [String]
-
-password for login
-
-### method [String]
-
-http request method, only supports GET, POST method
-
-### params [Map]
-
-http params
-
-### body [String]
-
-http body
-
-### poll_interval_ms [int]
+## Description
-request http api interval(millis) in stream mode
+Used to read data from My Hours.
-### retry [int]
+## Key features
-The max retry times if request http return to `IOException`
+- [x] [batch](../../concept/connector-v2-features.md)
+- [ ] [stream](../../concept/connector-v2-features.md)
+- [ ] [exactly-once](../../concept/connector-v2-features.md)
+- [ ] [column projection](../../concept/connector-v2-features.md)
+- [ ] [parallelism](../../concept/connector-v2-features.md)
+- [ ] [support user-defined split](../../concept/connector-v2-features.md)
-### retry_backoff_multiplier_ms [int]
+## Supported DataSource Info
+
+In order to use the My Hours connector, the following dependencies are
required.
+They can be downloaded via install-plugin.sh or from the Maven central
repository.
+
+| Datasource | Supported Versions | Dependency
|
+|------------|--------------------|------------------------------------------------------------------------------------------------|
+| My Hours | universal |
[Download](https://mvnrepository.com/artifact/org.apache.seatunnel/seatunnel-connectors-v2)
|
+
+## Source Options
+
+| Name | Type | Required | Default | Description
|
+|-----------------------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
+| url | String | Yes | - | Http request
url.
|
+| email | String | Yes | - | My hours login
email address.
|
+| password | String | Yes | - | My hours login
password.
|
+| schema | Config | No | - | Http and
seatunnel data structure mapping
|
+| schema.fields | Config | No | - | The schema
fields of upstream data
|
+| json_field | Config | No | - | This parameter
helps you configure the schema,so this parameter must be used with schema.
|
+| content_json | String | No | - | This parameter
can get some json data.If you only need the data in the 'book' section,
configure `content_field = "$.store.book.*"`. |
+| format | String | No | json | The format of
upstream data, now only support `json` `text`, default `json`.
|
+| method | String | No | get | Http request
method, only supports GET, POST method.
|
+| headers | Map | No | - | Http headers.
|
+| params | Map | No | - | Http params.
|
+| body | String | No | - | Http body.
|
+| poll_interval_ms | Int | No | - | Request http
api interval(millis) in stream mode.
|
+| retry | Int | No | - | The max retry
times if request http return to `IOException`.
|
+| retry_backoff_multiplier_ms | Int | No | 100 | The
retry-backoff times(millis) multiplier if request http failed.
|
+| retry_backoff_max_ms | Int | No | 10000 | The maximum
retry-backoff times(millis) if request http failed
|
+| enable_multi_lines | Boolean | No | false |
|
+| common-options | | No | - | Source plugin
common parameters, please refer to [Source Common Options](common-options.md)
for details |
+
+## How to Create a My Hours Data Synchronization Jobs
-The retry-backoff times(millis) multiplier if request http failed
+```hocon
+env {
+ execution.parallelism = 1
+ job.mode = "BATCH"
+}
-### retry_backoff_max_ms [int]
+MyHours{
+ url = "https://api2.myhours.com/api/Projects/getAll";
+ email = "[email protected]"
+ password = "seatunnel"
+ schema {
+ fields {
+ name = string
+ archived = boolean
+ dateArchived = string
+ dateCreated = string
+ clientName = string
+ budgetAlertPercent = string
+ budgetType = int
+ totalTimeLogged = double
+ budgetValue = double
+ totalAmount = double
+ totalExpense = double
+ laborCost = double
+ totalCost = double
+ billableTimeLogged = double
+ totalBillableAmount = double
+ billable = boolean
+ roundType = int
+ roundInterval = int
+ budgetSpentPercentage = double
+ budgetTarget = int
+ budgetPeriodType = string
+ budgetSpent = string
+ id = string
+ }
+ }
+}
-The maximum retry-backoff times(millis) if request http failed
+# Console printing of the read data
+sink {
+ Console {
+ parallelism = 1
Review Comment:
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
