Skip to content
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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Conversation

asimms41
Copy link
Collaborator

@asimms41 asimms41 commented Feb 24, 2025

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:

  • Simplified and clarified various descriptions, such as changing "Connects to a server and continuously performs requests for a single message" to "Connects to a server and continuously requests single messages."
  • Added optional indicators for fields that do not have default values, such as oauth.consumer_key, oauth.consumer_secret, and others.
  • Improved the explanation of dynamic URL and header settings and pagination, making it easier to understand how function interpolations can be used.
  • Enhanced descriptions for OAuth and JWT authentication fields, providing clearer guidance on their usage. [1] [2]

Consistency and Formatting:

  • Standardized terminology and formatting, such as changing "Common config fields, showing default values" to "Common configuration fields, showing default values."
  • Reformatted examples and tips for better readability and consistency across the document. [1] [2]
  • Ensured all field descriptions are concise and follow a consistent structure, such as "The URL to connect to. This field supports interpolation functions."

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

Updates for consistency

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Copy link

netlify bot commented Feb 24, 2025

Deploy Preview for redpanda-connect ready!

Name Link
🔨 Latest commit 9188304
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-connect/deploys/67bc7995b345610008219287
😎 Deploy Preview https://deploy-preview-176--redpanda-connect.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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].
Copy link
Collaborator Author

@asimms41 asimms41 Feb 24, 2025

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.

Copy link
Collaborator

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.

Copy link
Collaborator Author

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?

Copy link
Collaborator

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.

Copy link
Collaborator

@mihaitodor mihaitodor left a 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)
Copy link
Collaborator

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.

Copy link
Collaborator Author

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?

Copy link
Collaborator

@mihaitodor mihaitodor Feb 25, 2025

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].
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants