Document force options in supervisor endpoints

[mdegat01]

Proposed change

Document new force options added in home-assistant/supervisor#5205

Type of change

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

Additional information

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request: Restrict stopping core during migrations with force option supervisor#5205

Summary by CodeRabbit

• New Features

  • Introduced a new optional force parameter to key API endpoints, allowing users to enforce actions during offline database migrations for improved control.

• Documentation

  • Updated API documentation to reflect the addition and functionality of the force parameter across various endpoints.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes introduce a new optional parameter, force, to several API endpoints in Home Assistant's core and host management. This boolean parameter, with a default value of True, allows users to enforce actions during offline database migrations. The enhancement improves operational flexibility and user control over core container actions and host management tasks, ensuring system integrity and performance during critical maintenance scenarios.

Changes

File Path	Change Summary
docs/api/supervisor/endpoints.md	Added force parameter (boolean, default True) to endpoints: /core/rebuild, /core/restart, /core/stop, /host/reboot, /host/shutdown for enforcing actions during offline database migrations.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a34195d and 6d814ad.

Files selected for processing (1)

• docs/api/supervisor/endpoints.md (5 hunks)

Additional comments not posted (5)

docs/api/supervisor/endpoints.md (5)

1229-1229: Verify the addition of the force parameter.

Ensure that the force parameter is correctly documented and consistent with other parameters.

---

1241-1241: Verify the addition of the force parameter.

Ensure that the force parameter is correctly documented and consistent with other parameters.

---

1277-1277: Verify the addition of the force parameter.

Ensure that the force parameter is correctly documented and consistent with other parameters.

---

1822-1822: Verify the addition of the force parameter.

Ensure that the force parameter is correctly documented and consistent with other parameters.

---

1875-1875: Verify the addition of the force parameter.

Ensure that the force parameter is correctly documented and consistent with other parameters.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.