Add docs for /docker/migrate-storage-driver Supervisor API

[sairon]

Proposed change

Add documentation for home-assistant/supervisor#6361

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

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request: Add API endpoint for migrating Docker storage driver supervisor#6361

Summary by CodeRabbit

• New Features
  • Added storage driver migration via the API: schedule migration to Containerd overlayfs or Docker overlay2 to take effect on next reboot. Requires Home Assistant OS 17.0 or newer. Calling the API will mark a reboot as required and create a resolution-center issue; a system reboot is needed to complete the migration.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Added documentation for a new POST /docker/migrate-storage-driver API endpoint that schedules storage driver migration (overlayfs or overlay2) for the next system reboot. Requires Home Assistant OS 17.0 or newer and triggers a reboot_required issue upon execution.

Changes

Cohort / File(s)	Summary
API Endpoint Documentation docs/api/supervisor/endpoints.md	Documented new POST /docker/migrate-storage-driver endpoint for scheduling Docker storage driver migrations; includes prerequisites (HAOS 17.0+), payload schema (storage_driver required, values overlayfs or overlay2), example payload, and reboot requirement which creates a reboot_required issue.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Review docs/api/supervisor/endpoints.md for accuracy of payload schema, prerequisite note, and example payload.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title clearly and specifically describes the main change: adding documentation for a Docker storage driver migration Supervisor API endpoint.
Description check	✅ Passed	The description follows the template structure with all required sections completed, including proposed change, type of change (with appropriate selection), documentation guidelines acknowledgment, and link to related Supervisor PR.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch document-supervisor-docker-migrate-storage-driver

---

📜 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 550b936 and ddb1288.

📒 Files selected for processing (1)

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

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/api/supervisor/endpoints.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

📜 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 4e8ea9d and 550b936.

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

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

1640-1669: Well-structured endpoint documentation.

The endpoint documentation is comprehensive and follows established conventions. It clearly describes the migration functionality, prerequisites, required payload, and expected outcomes. The placement within the Docker section is logical and consistent with the file's organization.