-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC-768 Update http components #176
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
||
== Propagate responses | ||
|
||
It's possible to propagate the response from each HTTP request back to the input source by setting `propagate_response` to `true`. Only inputs that support xref:guides:sync_responses.adoc[synchronous responses] are able to make use of these propagated responses. | ||
To propagate HTTP responses back to the input source, set the <<propagate_response,`propagate_response`>> field to `true` . This feature is only available for inputs that support xref:guides:sync_responses.adoc[synchronous responses]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you able to use the propagate_response
or extract_headers
fields in the Cloud? It looks like they both use http_server
, and so should be hidden.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You'd need an input which supports receiving these and I think http_server
is the only one which does currently. If they don't use that input, they probably won't care about this feature.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it make sense to condition these features out for Cloud users, i.e. this description, and the propagate_response
, extract_headers
fields? WDYT @mihaitodor and @Jeffail?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, thats fine with me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you!
@@ -54,36 +49,36 @@ input: | |||
metadata: | |||
include_prefixes: [] | |||
include_patterns: [] | |||
dump_request_log_level: "" | |||
dump_request_log_level: "" # No default (optional) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have the context around these changes, but I wonder if the "no default" wording can get confusing, since an empty string (""
) can be considered a default value. Connect shouldn't behave differently if, for example, dump_request_log_level: ""
is present in the config or if it's omitted entirely.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have had feedback that users are not sure which are optional values and which are required. This is an attempt to resolve this. I could just change the labelling to Optional
? WDYT @mihaitodor and @Jeffail?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could just change the labelling to
Optional
?
Sure, that makes sense to me
|
||
== Propagate responses | ||
|
||
It's possible to propagate the response from each HTTP request back to the input source by setting `propagate_response` to `true`. Only inputs that support xref:guides:sync_responses.adoc[synchronous responses] are able to make use of these propagated responses. | ||
To propagate HTTP responses back to the input source, set the <<propagate_response,`propagate_response`>> field to `true` . This feature is only available for inputs that support xref:guides:sync_responses.adoc[synchronous responses]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You'd need an input which supports receiving these and I think http_server
is the only one which does currently. If they don't use that input, they probably won't care about this feature.
Description
Resolves DOC-768
Review deadline: 26th February
Related PR to add these docs to the Cloud docs set: redpanda-data/cloud-docs#209
This pull request includes several updates to the
modules/components/pages/inputs/http_client.adoc
file, primarily focusing on improving clarity, consistency, and accuracy in the documentation. The most important changes include refining descriptions, adding optional indicators for certain fields, and reformatting for better readability.Documentation Improvements:
oauth.consumer_key
,oauth.consumer_secret
, and others.Consistency and Formatting:
These changes collectively enhance the usability and accuracy of the documentation, making it easier for users to configure and understand the
http_client
component.Page previews
Main page updates
http_client
inputhttp_client
outputhttp
processorUpdates for consistency
websocket
outputwebsocket
inputschema_registry_decode
processorschema_registry_encode
processorChecks