Document system managed field for addons

[mdegat01]

Proposed change

Document new system managed options added for addons in home-assistant/supervisor#5145

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: Allow core to mark addons as system managed supervisor#5145

Summary by CodeRabbit

• Documentation
  • Updated Supervisor API documentation to include system_managed and system_managed_config_entry fields for add-on details.
  • Introduced a new API endpoint for managing add-on system options.
  • Added descriptions for system_managed attribute in the add-on models documentation, indicating Home Assistant management status.

[coderabbitai]

Walkthrough

Walkthrough

Recent updates to the Supervisor API documentation have introduced two new fields, system_managed and system_managed_config_entry, which indicate whether an add-on is managed by Home Assistant and provide the corresponding configuration entry ID. Additionally, a new API endpoint has been created, enhancing the interaction and management of add-ons within the Home Assistant ecosystem.

Changes

Files	Change Summary
docs/api/supervisor/endpoints.md, docs/api/supervisor/models.md	Added system_managed and system_managed_config_entry fields to add-on details; introduced new API endpoint for managing add-on system options.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 652084f and f862c34.

Files selected for processing (2)

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

Additional context used

Markdownlint

docs/api/supervisor/endpoints.md

325-325: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Additional comments not posted (3)

docs/api/supervisor/models.md (1)

24-24: LGTM! The new field system_managed is correctly documented.

The addition of the new field system_managed to the Addon model is well-documented and consistent with the existing fields.

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

45-46: Clarify system-managed fields in example response.

In the example response, the system_managed field is set to false. It's important to explain in the documentation that these values are examples and should be replaced with actual data in practical applications.

---

168-169: Ensure consistency in field descriptions.

The description for system_managed and system_managed_config_entry should be consistent with other field descriptions in terms of detail and clarity. Consider enhancing the description to explain possible values and implications of these fields.

---

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.

[coderabbitai]

Actionable comments posted: 2

[coderabbitai]

Actionable comments posted: 1

[coderabbitai]

Fix the heading formatting.

Use a proper heading instead of emphasis for the payload section to adhere to Markdownlint rules.

- **Payload**
+ #### Payload

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	<ApiEndpoint path="/addons/<addon>/sys_options" method="post">
	Change options specific to system managed addons.
	This endpoint is only callable by Home Assistant and not by any other client.
	**Payload**
	<ApiEndpoint path="/addons/<addon>/sys_options" method="post">
	Change options specific to system managed addons.
	This endpoint is only callable by Home Assistant and not by any other client.
	#### Payload

Tools

Markdownlint

325-325: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)