Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add missing payload_template config option in Scrape #39329

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 31, 2025
Merged

Add missing payload_template config option in Scrape #39329

merged 1 commit into from
May 31, 2025

Conversation

gjohansson-ST
Copy link
Member

@gjohansson-ST gjohansson-ST commented May 30, 2025 •
edited by coderabbitai bot
Loading

Proposed change

SSIA
#38747

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Added information about the new payload_template option for the scrape integration, enabling users to specify a POST request payload with template support.

@gjohansson-ST gjohansson-ST requested a review from fabaff as a code owner May 30, 2025 20:34
@home-assistant home-assistant bot added the current This PR goes into the current branch label May 30, 2025
@netlify Netlify
Copy link

netlify bot commented May 30, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit de045d8
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/683a165b0359140008603f97
😎 Deploy Preview https://deploy-preview-39329--home-assistant-docs.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 project configuration.

@gjohansson-ST gjohansson-ST mentioned this pull request May 30, 2025
Closed
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 30, 2025

📝 Walkthrough

Walkthrough

A new configuration option, payload_template, was added to the documentation for the scrape integration. This option enables users to specify a POST request payload with template support, in addition to the existing payload option. No other configuration changes or example updates were made.

Changes

File Change Summary
source/_integrations/scrape.markdown Documented new payload_template config option for POST payloads with template support.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ScrapeIntegration

    User->>ScrapeIntegration: Configure with payload_template
    ScrapeIntegration->>ScrapeIntegration: Render template for POST payload
    ScrapeIntegration->>ScrapeIntegration: Send POST request with rendered payload
Loading

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed May 30, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
source/_integrations/scrape.markdown (1)

63-66: Enhance docs with a concrete usage example.

Consider adding an example in the “Container cleaning by CleanProfs” section (or a new snippet) to illustrate how payload_template can substitute variables at runtime. For instance:

--- a/source/_integrations/scrape.markdown
+++ b/source/_integrations/scrape.markdown
@@ 277,283
-    method: POST
-    payload: zipcode=5624JW&street_number=17
+    method: POST
+    # Using payload_template to inject dynamic values
+    payload_template: "zipcode={{ zipcode }}&street_number={{ street_number }}"
     headers:
       Content-Type: application/x-www-form-urlencoded
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 3d4fd0d and de045d8.

📒 Files selected for processing (1)
  • source/_integrations/scrape.markdown (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/scrape.markdown (1)

63-66: Correctly document the payload_template option.

The new payload_template entry mirrors the existing payload field but adds template support, with the correct type: template and optional status. This aligns with other template-based configuration options in this file.

@silamon silamon merged commit 9c4011b into current May 31, 2025
9 checks passed
@silamon silamon deleted the gj-20250530-01 branch May 31, 2025 15:12
@github-actions github-actions bot locked and limited conversation to collaborators Jun 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@silamon silamon silamon approved these changes

@fabaff fabaff Awaiting requested review from fabaff fabaff is a code owner

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gjohansson-ST @silamon