This is an automated email from the ASF dual-hosted git repository. fcsaky pushed a commit to branch fix-history in repository https://gitbox.apache.org/repos/asf/flink-connector-http.git
commit 245cd0a85213dcef58c3b08553c4918475bae509 Author: Mariya George <[email protected]> AuthorDate: Fri Feb 27 12:43:01 2026 +0530 [hotfix] Fix typos in docs --- README.md | 2 +- docs/content.zh/docs/connectors/datastream/http.md | 10 +++++----- docs/content.zh/docs/connectors/table/http.md | 6 +++--- docs/content/docs/connectors/datastream/http.md | 10 +++++----- docs/content/docs/connectors/table/http.md | 6 +++--- tools/maven/checkstyle.xml | 2 +- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 72e900f..fe9e7b1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository contains the official Apache Flink HTTP connector. ## Apache Flink -Apache Flink is an open source stream processing framework with powerful stream- and batch-processing capabilities. +Apache Flink is an open source stream processing framework with powerful stream and batch processing capabilities. Learn more about Flink at [https://flink.apache.org/](https://flink.apache.org/) diff --git a/docs/content.zh/docs/connectors/datastream/http.md b/docs/content.zh/docs/connectors/datastream/http.md index 030cb26..c1e7499 100644 --- a/docs/content.zh/docs/connectors/datastream/http.md +++ b/docs/content.zh/docs/connectors/datastream/http.md @@ -50,13 +50,13 @@ The HTTP sink connector supports the Flink streaming API. In order to change submission batch size use `flink.connector.http.sink.request.batch.size` property. For example: ### Sink Connector options -These option are specified on the builder using the setProperty method. +These options are specified on the builder using the setProperty method. | Option | Required | Description/Value | |---------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | connector | required | Specify what connector to use. For HTTP Sink it should be set to _'http-sink'_. | | format | required | Specify what format to use. | -| url | required | The base URL that should be use for HTTP requests. For example _http://localhost:8080/client_. | +| url | required | The base URL that should be used for HTTP requests. For example _http://localhost:8080/client_. | | insert-method | optional | Specify which HTTP method to use in the request. The value should be set either to `POST` or `PUT`. | | sink.batch.max-size | optional | Maximum number of elements that may be passed in a batch to be written downstream. | | sink.requests.max-inflight | optional | The maximum number of in flight requests that may exist, if any more in flight requests need to be initiated once the maximum has been reached, then it will be blocked until some have completed. | @@ -66,7 +66,7 @@ These option are specified on the builder using the setProperty method. | flink.connector.http.sink.request-callback | optional | Specify which `HttpPostRequestCallback` implementation to use. By default, it is set to `slf4j-logger` corresponding to `Slf4jHttpPostRequestCallback`. | | flink.connector.http.sink.error.code | optional | List of HTTP status codes that should be treated as errors by HTTP Sink, separated with comma. | | flink.connector.http.sink.error.code.exclude | optional | List of HTTP status codes that should be excluded from the `flink.connector.http.sink.error.code` list, separated with comma. | -| flink.connector.http.security.cert.server | optional | Path to trusted HTTP server certificate that should be add to connectors key store. More than one path can be specified using `,` as path delimiter. | +| flink.connector.http.security.cert.server | optional | Path to trusted HTTP server certificate that should be added to connectors key store. More than one path can be specified using `,` as path delimiter. | | flink.connector.http.security.cert.client | optional | Path to trusted certificate that should be used by connector's HTTP client for mTLS communication. | | flink.connector.http.security.key.client | optional | Path to trusted private key that should be used by connector's HTTP client for mTLS communication. | | flink.connector.http.security.cert.server.allowSelfSigned | optional | Accept untrusted certificates for TLS communication. | @@ -80,7 +80,7 @@ These option are specified on the builder using the setProperty method. ### Batch submission mode By default, batch size is set to 500 which is the same as Http Sink's `maxBatchSize` property and has value of 500. -The `maxBatchSize' property sets maximal number of events that will by buffered by Flink runtime before passing it to Http Sink for processing. +The `maxBatchSize` property sets maximal number of events that will be buffered by Flink runtime before passing it to Http Sink for processing. Streaming API: ```java @@ -105,7 +105,7 @@ HttpSink.<String>builder() .build(); ``` ### Http headers -It is possible to set HTTP headers that will be added to HTTP request send by sink connector. +It is possible to set HTTP headers that will be added to HTTP request sent by sink connector. Headers are defined via property key `flink.connector.http.sink.header.HEADER_NAME = header value` for example: `flink.connector.http.sink.header.X-Content-Type-Options = nosniff`. Properties can be set via Sink builder or Property object: diff --git a/docs/content.zh/docs/connectors/table/http.md b/docs/content.zh/docs/connectors/table/http.md index aa3c187..2bc8643 100644 --- a/docs/content.zh/docs/connectors/table/http.md +++ b/docs/content.zh/docs/connectors/table/http.md @@ -386,7 +386,7 @@ another format name. |-------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | connector | required | Specify what connector to use. For HTTP Sink it should be set to _'http-sink'_. | | format | required | Specify what format to use. | -| url | required | The base URL that should be use for HTTP requests. For example _http://localhost:8080/client_. | +| url | required | The base URL that should be used for HTTP requests. For example _http://localhost:8080/client_. | | insert-method | optional | Specify which HTTP method to use in the request. The value should be set either to `POST` or `PUT`. | | sink.batch.max-size | optional | Maximum number of elements that may be passed in a batch to be written downstream. | | sink.requests.max-inflight | optional | The maximum number of in flight requests that may exist, if any more in flight requests need to be initiated once the maximum has been reached, then it will be blocked until some have completed. | @@ -397,7 +397,7 @@ another format name. | http.sink.request-callback | optional | Specify which `HttpPostRequestCallback` implementation to use. By default, it is set to `slf4j-logger` corresponding to `Slf4jHttpPostRequestCallback`. | | http.sink.error.code | optional | List of HTTP status codes that should be treated as errors by HTTP Sink, separated with comma. | | http.sink.error.code.exclude | optional | List of HTTP status codes that should be excluded from the `http.sink.error.code` list, separated with comma. | -| http.security.cert.server | optional | Path to trusted HTTP server certificate that should be add to connectors key store. More than one path can be specified using `,` as path delimiter. | +| http.security.cert.server | optional | Path to trusted HTTP server certificate that should be added to connectors key store. More than one path can be specified using `,` as path delimiter. | | http.security.cert.client | optional | Path to trusted certificate that should be used by connector's HTTP client for mTLS communication. | | http.security.key.client | optional | Path to trusted private key that should be used by connector's HTTP client for mTLS communication. | | http.security.cert.server.allowSelfSigned | optional | Accept untrusted certificates for TLS communication. | @@ -462,7 +462,7 @@ An example of Http Sink batch request body containing data for three events: ``` By default, batch size is set to 500 which is the same as Http Sink's `maxBatchSize` property and has value of 500. -The `maxBatchSize` property sets maximal number of events that will by buffered by Flink runtime before passing it to Http Sink for processing. +The `maxBatchSize` property sets maximal number of events that will be buffered by Flink runtime before passing it to Http Sink for processing. ```roomsql CREATE TABLE http ( diff --git a/docs/content/docs/connectors/datastream/http.md b/docs/content/docs/connectors/datastream/http.md index 030cb26..c1e7499 100644 --- a/docs/content/docs/connectors/datastream/http.md +++ b/docs/content/docs/connectors/datastream/http.md @@ -50,13 +50,13 @@ The HTTP sink connector supports the Flink streaming API. In order to change submission batch size use `flink.connector.http.sink.request.batch.size` property. For example: ### Sink Connector options -These option are specified on the builder using the setProperty method. +These options are specified on the builder using the setProperty method. | Option | Required | Description/Value | |---------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | connector | required | Specify what connector to use. For HTTP Sink it should be set to _'http-sink'_. | | format | required | Specify what format to use. | -| url | required | The base URL that should be use for HTTP requests. For example _http://localhost:8080/client_. | +| url | required | The base URL that should be used for HTTP requests. For example _http://localhost:8080/client_. | | insert-method | optional | Specify which HTTP method to use in the request. The value should be set either to `POST` or `PUT`. | | sink.batch.max-size | optional | Maximum number of elements that may be passed in a batch to be written downstream. | | sink.requests.max-inflight | optional | The maximum number of in flight requests that may exist, if any more in flight requests need to be initiated once the maximum has been reached, then it will be blocked until some have completed. | @@ -66,7 +66,7 @@ These option are specified on the builder using the setProperty method. | flink.connector.http.sink.request-callback | optional | Specify which `HttpPostRequestCallback` implementation to use. By default, it is set to `slf4j-logger` corresponding to `Slf4jHttpPostRequestCallback`. | | flink.connector.http.sink.error.code | optional | List of HTTP status codes that should be treated as errors by HTTP Sink, separated with comma. | | flink.connector.http.sink.error.code.exclude | optional | List of HTTP status codes that should be excluded from the `flink.connector.http.sink.error.code` list, separated with comma. | -| flink.connector.http.security.cert.server | optional | Path to trusted HTTP server certificate that should be add to connectors key store. More than one path can be specified using `,` as path delimiter. | +| flink.connector.http.security.cert.server | optional | Path to trusted HTTP server certificate that should be added to connectors key store. More than one path can be specified using `,` as path delimiter. | | flink.connector.http.security.cert.client | optional | Path to trusted certificate that should be used by connector's HTTP client for mTLS communication. | | flink.connector.http.security.key.client | optional | Path to trusted private key that should be used by connector's HTTP client for mTLS communication. | | flink.connector.http.security.cert.server.allowSelfSigned | optional | Accept untrusted certificates for TLS communication. | @@ -80,7 +80,7 @@ These option are specified on the builder using the setProperty method. ### Batch submission mode By default, batch size is set to 500 which is the same as Http Sink's `maxBatchSize` property and has value of 500. -The `maxBatchSize' property sets maximal number of events that will by buffered by Flink runtime before passing it to Http Sink for processing. +The `maxBatchSize` property sets maximal number of events that will be buffered by Flink runtime before passing it to Http Sink for processing. Streaming API: ```java @@ -105,7 +105,7 @@ HttpSink.<String>builder() .build(); ``` ### Http headers -It is possible to set HTTP headers that will be added to HTTP request send by sink connector. +It is possible to set HTTP headers that will be added to HTTP request sent by sink connector. Headers are defined via property key `flink.connector.http.sink.header.HEADER_NAME = header value` for example: `flink.connector.http.sink.header.X-Content-Type-Options = nosniff`. Properties can be set via Sink builder or Property object: diff --git a/docs/content/docs/connectors/table/http.md b/docs/content/docs/connectors/table/http.md index 79c3315..9444b83 100644 --- a/docs/content/docs/connectors/table/http.md +++ b/docs/content/docs/connectors/table/http.md @@ -386,7 +386,7 @@ another format name. |-------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | connector | required | Specify what connector to use. For HTTP Sink it should be set to _'http-sink'_. | | format | required | Specify what format to use. | -| url | required | The base URL that should be use for HTTP requests. For example _http://localhost:8080/client_. | +| url | required | The base URL that should be used for HTTP requests. For example _http://localhost:8080/client_. | | insert-method | optional | Specify which HTTP method to use in the request. The value should be set either to `POST` or `PUT`. | | sink.batch.max-size | optional | Maximum number of elements that may be passed in a batch to be written downstream. | | sink.requests.max-inflight | optional | The maximum number of in flight requests that may exist, if any more in flight requests need to be initiated once the maximum has been reached, then it will be blocked until some have completed. | @@ -397,7 +397,7 @@ another format name. | http.sink.request-callback | optional | Specify which `HttpPostRequestCallback` implementation to use. By default, it is set to `slf4j-logger` corresponding to `Slf4jHttpPostRequestCallback`. | | http.sink.error.code | optional | List of HTTP status codes that should be treated as errors by HTTP Sink, separated with comma. | | http.sink.error.code.exclude | optional | List of HTTP status codes that should be excluded from the `http.sink.error.code` list, separated with comma. | -| http.security.cert.server | optional | Path to trusted HTTP server certificate that should be add to connectors key store. More than one path can be specified using `,` as path delimiter. | +| http.security.cert.server | optional | Path to trusted HTTP server certificate that should be added to connectors key store. More than one path can be specified using `,` as path delimiter. | | http.security.cert.client | optional | Path to trusted certificate that should be used by connector's HTTP client for mTLS communication. | | http.security.key.client | optional | Path to trusted private key that should be used by connector's HTTP client for mTLS communication. | | http.security.cert.server.allowSelfSigned | optional | Accept untrusted certificates for TLS communication. | @@ -462,7 +462,7 @@ An example of Http Sink batch request body containing data for three events: ``` By default, batch size is set to 500 which is the same as Http Sink's `maxBatchSize` property and has value of 500. -The `maxBatchSize` property sets maximal number of events that will by buffered by Flink runtime before passing it to Http Sink for processing. +The `maxBatchSize` property sets maximal number of events that will be buffered by Flink runtime before passing it to Http Sink for processing. ```roomsql CREATE TABLE http ( diff --git a/tools/maven/checkstyle.xml b/tools/maven/checkstyle.xml index e44bd6f..0a05bf2 100644 --- a/tools/maven/checkstyle.xml +++ b/tools/maven/checkstyle.xml @@ -34,7 +34,7 @@ This file is based on the checkstyle file of Apache Beam. <module name="Checker"> <module name="NewlineAtEndOfFile"> - <!-- windows can use \r\n vs \n, so enforce the most used one ie UNIx style --> + <!-- windows can use \r\n vs \n, so enforce the most used one ie UNIX style --> <property name="lineSeparator" value="lf"/> </module>
