You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "InfoSec812 (via GitHub)" <gi...@apache.org> on 2023/11/16 16:14:17 UTC
[PR] [WIP] Improve the documentation for httpHeaders parameter. [camel]
InfoSec812 opened a new pull request, #12018:
URL: https://github.com/apache/camel/pull/12018
# Description
The documentation for the `httpHeaders` parameter of the `stream` component is ambiguous about how to format the parameter. It appears from the documentation that one would use `HEADER: VALUE`; but the code requires using `HEADER=VALUE`
# Target
- [X] I checked that the commit is targeting the correct branch (note that Camel 3 uses `camel-3.x`, whereas Camel 4 uses the `main` branch)
# Tracking
- [ ] If this is a large change, bug fix, or code improvement, I checked there is a [JIRA issue](https://issues.apache.org/jira/browse/CAMEL) filed for the change (usually before you start working on it).
<!--
# *Note*: trivial changes like, typos, minor documentation fixes and other small items do not require a JIRA issue. In this case your pull request should address just this issue, without pulling in other changes.
-->
# Apache Camel coding standards and style
- [ ] I checked that each commit in the pull request has a meaningful subject line and body.
<!--
If you're unsure, you can format the pull request title like `[CAMEL-XXX] Fixes bug in camel-file component`, where you replace `CAMEL-XXX` with the appropriate JIRA issue.
-->
- [ ] I have run `mvn clean install -DskipTests` locally and I have committed all auto-generated changes
Having issues getting this to run as there are other modules preventing the build.
<!--
You can run the aforementioned command in your module so that the build auto-formats your code. This will also be verified as part of the checks and your PR may be rejected if if there are uncommited changes after running `mvn clean install -DskipTests`.
You can learn more about the contribution guidelines at https://github.com/apache/camel/blob/main/CONTRIBUTING.md
-->
--
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: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [WIP] Improve the documentation for httpHeaders parameter. [camel]
Posted by "InfoSec812 (via GitHub)" <gi...@apache.org>.
InfoSec812 commented on PR #12018:
URL: https://github.com/apache/camel/pull/12018#issuecomment-1815249553
Just to be clear, I was unable to run the maven build to generate files due to errors in other modules, so there may need to be other changes.
--
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: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [WIP] Improve the documentation for httpHeaders parameter. [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus commented on code in PR #12018:
URL: https://github.com/apache/camel/pull/12018#discussion_r1396248724
##########
components/camel-stream/src/main/java/org/apache/camel/component/stream/StreamEndpoint.java:
##########
@@ -145,7 +145,8 @@ public String getHttpHeaders() {
/**
* When using stream:http format, this option specifies optional http headers, such as Accept: application/json.
- * Multiple headers can be separated by comma.
+ * Multiple headers can be separated by comma. The format of headers should be {@code HEADER=VALUE}. An example
Review Comment:
We usually do not use @code or other formatting as the text is being extracted for tooling as well and they use plain text. So it would be good to get that removed, thanks.
--
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: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [WIP] Improve the documentation for httpHeaders parameter. [camel]
Posted by "InfoSec812 (via GitHub)" <gi...@apache.org>.
InfoSec812 commented on code in PR #12018:
URL: https://github.com/apache/camel/pull/12018#discussion_r1396269424
##########
components/camel-stream/src/main/java/org/apache/camel/component/stream/StreamEndpoint.java:
##########
@@ -145,7 +145,8 @@ public String getHttpHeaders() {
/**
* When using stream:http format, this option specifies optional http headers, such as Accept: application/json.
- * Multiple headers can be separated by comma.
+ * Multiple headers can be separated by comma. The format of headers should be {@code HEADER=VALUE}. An example
Review Comment:
I have made the requested changes.
--
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: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [WIP] Improve the documentation for httpHeaders parameter. [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus merged PR #12018:
URL: https://github.com/apache/camel/pull/12018
--
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: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [WIP] Improve the documentation for httpHeaders parameter. [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #12018:
URL: https://github.com/apache/camel/pull/12018#issuecomment-1814773848
:star2: Thank you for your contribution to the Apache Camel project! :star2:
:robot: CI automation will test this PR automatically.
:camel: Apache Camel Committers, please review the following items:
* First-time contributors **require MANUAL approval** for the GitHub Actions to run
* You can use the command `/component-test (camel-)component-name1 (camel-)component-name2..` to request a test from the test bot.
* You can label PRs using `build-all`, `build-dependents`, `skip-tests` and `test-dependents` to fine-tune the checks executed by this PR.
* Build and test logs are available in the Summary page. **Only** [Apache Camel committers](https://camel.apache.org/community/team/#committers) have access to the summary.
* :warning: Be careful when sharing logs. Review their contents before sharing them publicly.
--
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: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org