Skip to content

Conversation

mdegat01
Copy link
Contributor

@mdegat01 mdegat01 commented Oct 1, 2025

Proposed change

Remove documentation for deprecated fields and options being removed in home-assistant/supervisor#6226

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

Summary by CodeRabbit

  • Documentation
    • Removed wait_boot and addons_repositories fields from the Supervisor API documentation across relevant endpoints.
    • Updated response tables and example payloads to exclude these fields for accuracy.
    • Clarified that clients should no longer expect these fields in API responses or request options.

Copy link
Contributor

coderabbitai bot commented Oct 1, 2025

📝 Walkthrough

Walkthrough

Removed wait_boot and addons_repositories fields from supervisor API documentation, including their mentions in info endpoint examples and options payloads/responses.

Changes

Cohort / File(s) Summary of changes
Supervisor API docs
docs/api/supervisor/endpoints.md
Removed documentation and examples for fields: wait_boot and addons_repositories across supervisor info and options sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning Despite correctly using the template structure, the description leaves multiple required checklist items unchecked, misclassifies the type of change by selecting documentation of existing features instead of removing deprecated content, and omits a linked issue number under fixes or closes, resulting in an incomplete template fulfillment. Please update the type of change to “Remove stale or deprecated documentation,” complete the checklist by verifying guideline adherence and rendering, and include a valid issue number if applicable under the fixes or closes section to fully satisfy the repository’s description template requirements.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title accurately and concisely conveys the main change of removing deprecated fields and options from the Supervisor API, reflecting the modifications in the documentation without extraneous detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch remove-deprecated-supervisor-fields

📜 Recent 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 cceb85d and 7c96c91.

📒 Files selected for processing (1)
  • docs/api/supervisor/endpoints.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/api/supervisor/endpoints.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - developers-home-assistant
  • GitHub Check: Header rules - developers-home-assistant
  • GitHub Check: Pages changed - developers-home-assistant

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

✅ Approved. Can be merged as soon as the parent PR gets merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants