Hisoka-X commented on code in PR #8434:
URL: https://github.com/apache/seatunnel/pull/8434#discussion_r1957533851
##########
docs/en/connector-v2/source/Http.md:
##########
@@ -42,31 +42,33 @@ They can be downloaded via install-plugin.sh or from the
Maven central repositor
## Source Options
-| Name | Type | Required | Default |
Description
|
-|-----------------------------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------|
-| url | String | Yes | - | Http request
url.
|
-| 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.
|
-| pageing | Config | No | - | This parameter
is used for paging queries
|
-| pageing.page_field | String | No | - | This parameter
is used to specify the page field name in the request parameter
|
-| pageing.total_page_size | Int | No | - | This parameter
is used to control the total number of pages
|
-| pageing.batch_size | Int | No | - | The batch size
returned per request is used to determine whether to continue when the total
number of pages is unknown |
-| pageing.start_page_number | Int | No | 1 | Specify the
page number from which synchronization starts
|
-| 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 | text | The format of
upstream data, now only support `json` `text`, default `text`.
|
-| method | String | No | get | Http request
method, only supports GET, POST method.
|
-| headers | Map | No | - | Http headers.
|
-| params | Map | No | - | Http params,the
program will automatically add http header application/x-www-form-urlencoded.
|
-| body | String | No | - | Http body,the
program will automatically add http header application/json,body is jsonbody.
|
-| poll_interval_millis | 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 |
|
-| connect_timeout_ms | Int | No | 12000 | Connection
timeout setting, default 12s.
|
-| socket_timeout_ms | Int | No | 60000 | Socket timeout
setting, default 60s.
|
-| common-options | | No | - | Source plugin
common parameters, please refer to [Source Common
Options](../source-common-options.md) for details |
+| Name | Type | Required | Default | Description
|
+|-----------------------------|---------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| url | String | Yes | - | Http request
url.
|
+| 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.
|
+| pageing | Config | No | - | This parameter
is used for paging queries
|
+| pageing.page_field | String | No | - | This parameter
is used to specify the page field name in the request parameter
|
+| pageing.total_page_size | Int | No | - | This parameter
is used to control the total number of pages
|
+| pageing.batch_size | Int | No | - | The batch size
returned per request is used to determine whether to continue when the total
number of pages is unknown
|
+| pageing.start_page_number | Int | No | 1 | Specify the
page number from which synchronization starts
|
+| 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 | text | The format of
upstream data, now only support `json` `text`, default `text`.
|
+| 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,the
program will automatically add http header application/json,body is jsonbody.
|
+| poll_interval_millis | 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 |
|
+| connect_timeout_ms | Int | No | 12000 | Connection
timeout setting, default 12s.
|
+| socket_timeout_ms | Int | No | 60000 | Socket timeout
setting, default 60s.
|
+| common-options | | No | - | Source plugin
common parameters, please refer to [Source Common
Options](../source-common-options.md) for details
|
+| keep_params_as_form | Boolean | No | false |
Whether the params are submitted according to the form, used for compatibility
with legacy behaviors. When true, the value of the params parameter is
submitted through the form. |
+| keep_page_param_as_http_param | Boolean | No | false
| Whether to set the paging parameters to params.
|
Review Comment:
```suggestion
| keep_page_param_as_http_param | Boolean | No | false
| Whether to set the paging parameters to params. For compatibility with
legacy behaviors.
|
```
##########
docs/en/connector-v2/source/Http.md:
##########
@@ -181,6 +183,46 @@ connector will generate data as the following:
|----------------------------------------------------------|
| {"code": 200, "data": "get success", "success": true} |
+### keep_params_as_form
+For compatibility with old versions of http.
+When set to true,`<params>` and `<pageing>` will be submitted in the form.
+When set to false，`<params>` will be added to the url path,and `<pageing>`
will be added to the body
Review Comment:
```suggestion
When set to false，`<params>` will be added to the url path,and `<pageing>`
will not be added to the body or form. It will replace placeholders in params
and body.
```
--
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]
