Add documentation for OneDrive #36768
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughA new markdown documentation file for the OneDrive integration has been added to Home Assistant. The file provides comprehensive details about integrating OneDrive with Home Assistant Backups, including setup instructions, configuration requirements, and usage guidelines. It covers obtaining application credentials, supports account linking, and highlights current limitations such as support only for personal OneDrive accounts. Changes
Sequence DiagramsequenceDiagram
participant User
participant HomeAssistant
participant OneDrive
participant AzurePortal
User->>AzurePortal: Create client credentials
AzurePortal-->>User: Provide Client ID and Secret
User->>HomeAssistant: Configure OneDrive Integration
HomeAssistant->>OneDrive: Request Authorization
OneDrive-->>HomeAssistant: Grant Access
HomeAssistant->>OneDrive: Create Backup in App Folder
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/onedrive.markdown (3)
16-16: Fix grammatical errorThe sentence structure needs improvement.
-Backups will be created in the `App Folder` of your OneDrive, the integration does have no access to any other parts of your OneDrive except its own folder. +Backups will be created in the `App Folder` of your OneDrive. The integration has no access to any other parts of your OneDrive except its own folder.
32-32: Fix typo in limitationsThere's a grammatical error in the limitation statement.
-Only personal OneDrives are supported a the moment +Only personal OneDrives are supported at the moment🧰 Tools
🪛 LanguageTool
[grammar] ~32-~32: Two determiners in a row. Choose either “a” or “the”.
Context: ...- Only personal OneDrives are supported a the moment ## Removing the integration Th...(DT_DT)
1-38: Consider enhancing the documentationTo make the documentation more comprehensive, consider adding:
- A list of prerequisites (e.g., OneDrive account requirements)
- Examples of common use cases
- Troubleshooting section for common issues
- Information about backup retention policies or storage limits
Would you like me to help draft these additional sections?
🧰 Tools
🪛 LanguageTool
[misspelling] ~27-~27: Did you mean “ever”?
Context: ...one in the user context, so nobody will every have access to your data except you. Ho...(EVERY_EVER)
[grammar] ~32-~32: Two determiners in a row. Choose either “a” or “the”.
Context: ...- Only personal OneDrives are supported a the moment ## Removing the integration Th...(DT_DT)
🪛 Markdownlint (0.37.0)
26-26: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
28-28: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
🪛 GitHub Actions: home-assistant.io Test
[error] 26-26: Incorrect usage of the term: "Home assistant", use "Home Assistant" instead
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/onedrive.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/onedrive.markdown
[misspelling] ~27-~27: Did you mean “ever”?
Context: ...one in the user context, so nobody will every have access to your data except you. Ho...
(EVERY_EVER)
[grammar] ~32-~32: Two determiners in a row. Choose either “a” or “the”.
Context: ...- Only personal OneDrives are supported a the moment ## Removing the integration Th...
(DT_DT)
🪛 Markdownlint (0.37.0)
source/_integrations/onedrive.markdown
26-26: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
28-28: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/onedrive.markdown
[error] 26-26: Incorrect usage of the term: "Home assistant", use "Home Assistant" instead
⏰ 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 (2)
source/_integrations/onedrive.markdown (2)
34-38: LGTM!The removal instructions are clear and follow the standard template.
4-4: Verify the release versionThe release version is set to
2025.2. Please ensure this aligns with the planned release schedule and the parent PR in the core repository.✅ Verification successful
Release version 2025.2 is correctly set
The version aligns with other new integrations in the documentation, particularly the Overseerr integration which also targets the 2025.2 release.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check the version in the core PR gh api repos/home-assistant/core/pulls/134584 | jq -r '.body' | grep -i "version\|release"Length of output: 308
Script:
#!/bin/bash # Check manifest.json in the integration directory fd manifest.json --exec cat {} \; | grep -i "version" # Also check other recent integration docs for version patterns fd -e markdown -p 'source/_integrations' --changed-within 3months --exec grep -l "ha_release: 2025" {} \;Length of output: 534
Script:
#!/bin/bash # Check the exact version numbers in the found integration docs for file in ./source/_integrations/{harvey,cookidoo,peblar,slide_local,overseerr,powerfox,ohme,onedrive,eheimdigital}.markdown; do echo "=== $file ===" grep "ha_release:" "$file" doneLength of output: 2834
| This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home assistant account linking. | ||
| Everything is done in the user context, so nobody will every have access to your data except you. However, because you want to your own credentials this is possible, | ||
| follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret |
There was a problem hiding this comment.
Fix multiple text issues
There are several issues in this section that need to be addressed:
- Incorrect capitalization of "Home assistant"
- Typo: "every" should be "ever"
- Incomplete/unclear sentence about custom credentials
-This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home assistant account linking.
-Everything is done in the user context, so nobody will every have access to your data except you. However, because you want to your own credentials this is possible,
-follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret
+This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home Assistant account linking.
+Everything is done in the user context, so nobody will ever have access to your data except you. However, if you want to use your own credentials,
+follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret.📝 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.
| This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home assistant account linking. | |
| Everything is done in the user context, so nobody will every have access to your data except you. However, because you want to your own credentials this is possible, | |
| follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret | |
| This integration comes with a predefined set of [application credentials](https://www.home-assistant.io/integrations/application_credentials/) through Home Assistant account linking. | |
| Everything is done in the user context, so nobody will ever have access to your data except you. However, if you want to use your own credentials, | |
| follow [this guide](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) to create your own client ID and secret. |
🧰 Tools
🪛 LanguageTool
[misspelling] ~27-~27: Did you mean “ever”?
Context: ...one in the user context, so nobody will every have access to your data except you. Ho...
(EVERY_EVER)
🪛 Markdownlint (0.37.0)
26-26: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
28-28: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
🪛 GitHub Actions: home-assistant.io Test
[error] 26-26: Incorrect usage of the term: "Home assistant", use "Home Assistant" instead
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/onedrive.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/onedrive.markdown
[grammar] ~32-~32: Two determiners in a row. Choose either “a” or “the”.
Context: ...- Only personal OneDrives are supported a the moment ## Removing the integration Th...
(DT_DT)
🪛 Markdownlint (0.37.0)
source/_integrations/onedrive.markdown
26-26: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
⏰ 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 (2)
source/_integrations/onedrive.markdown (2)
4-4: Verify the release versionThe release version
2025.2seems unusually far in the future. Please confirm if this is the intended version or if it should be adjusted to a closer release.
26-28: LGTM! Clear and well-structured credentials sectionThe application credentials section provides clear instructions and good security context for users.
🧰 Tools
🪛 Markdownlint (0.37.0)
26-26: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
|
|
||
| ## Known Limitations | ||
|
|
||
| - Only personal OneDrives are supported a the moment |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix grammatical error
There's a grammatical error in the limitations statement.
-Only personal OneDrives are supported a the moment
+Only personal OneDrives are supported at the moment📝 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.
| - Only personal OneDrives are supported a the moment | |
| - Only personal OneDrives are supported at the moment |
🧰 Tools
🪛 LanguageTool
[grammar] ~32-~32: Two determiners in a row. Choose either “a” or “the”.
Context: ...- Only personal OneDrives are supported a the moment ## Removing the integration Th...
(DT_DT)
| --- | ||
|
|
||
| This integration allows you to use [OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for use with Home Assistant Backups. | ||
| Backups will be created in the `App Folder` of your OneDrive, the integration does have no access to any other parts of your OneDrive except its own folder. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve grammar and clarity
The sentence contains a grammatical error and could be clearer.
-Backups will be created in the `App Folder` of your OneDrive, the integration does have no access to any other parts of your OneDrive except its own folder.
+Backups will be created in the `App Folder` of your OneDrive. The integration only has access to this folder and cannot access any other parts of your OneDrive.📝 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.
| Backups will be created in the `App Folder` of your OneDrive, the integration does have no access to any other parts of your OneDrive except its own folder. | |
| Backups will be created in the `App Folder` of your OneDrive. The integration only has access to this folder and cannot access any other parts of your OneDrive. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/onedrive.markdown (1)
51-51: Improve precision in limitations statementConsider making the limitation statement more precise.
-Only personal OneDrives are supported at the moment +Only personal OneDrive accounts are currently supported🧰 Tools
🪛 LanguageTool
[style] ~51-~51: For conciseness, consider replacing this expression with an adverb.
Context: ...- Only personal OneDrives are supported at the moment ## Removing the integration This inte...(AT_THE_MOMENT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/onedrive.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/onedrive.markdown
[misspelling] ~18-~18: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ive. The integration only has access to a application specific home-assistant f...
(EN_A_VS_AN)
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ... to work: - Files.ReadWrite.AppFolder: Grants the application permission to re...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~51-~51: For conciseness, consider replacing this expression with an adverb.
Context: ...- Only personal OneDrives are supported at the moment ## Removing the integration This inte...
(AT_THE_MOMENT)
🪛 Markdownlint (0.37.0)
source/_integrations/onedrive.markdown
41-41: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
42-42: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
🔇 Additional comments (4)
source/_integrations/onedrive.markdown (4)
20-30: LGTM! Configuration section is well structuredThe configuration section follows the standard template and clearly documents the required parameters.
31-38: LGTM! Clear explanation of permissionsThe permissions section clearly explains each required permission and its purpose, helping users understand the security implications.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: Loose punctuation mark.
Context: ... to work: -Files.ReadWrite.AppFolder: Grants the application permission to re...(UNLIKELY_OPENING_PUNCTUATION)
39-48: LGTM! Application credentials section is clear and accurateThe section provides clear instructions for both default and custom credentials setup, with appropriate warnings about Azure requirements.
🧰 Tools
🪛 Markdownlint (0.37.0)
41-41: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
42-42: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
4-4: Verify the release versionThe release version is set to
2025.2. Please ensure this aligns with the planned release schedule and the parent PR in the core repository.✅ Verification successful
Release version 2025.2 is valid
The version aligns with other documented 2025.x releases and follows the established versioning pattern.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if the version exists in the core repository gh api repos/home-assistant/core/branches | jq -r '.[].name' | grep -E "release-202[0-9]\.[0-9]"Length of output: 98
Script:
#!/bin/bash # Find recent ha_release versions in integration files rg "ha_release: 202[0-9]\.[0-9]" "source/_integrations/" -l | while read -r file; do echo "=== $file ===" grep "ha_release:" "$file" doneLength of output: 68983
| This integration allows you to use [OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for use with Home Assistant Backups. | ||
|
|
||
| Backups will be created in a folder called `home-assistant\backups` in the `App Folder` of your OneDrive. | ||
| The integration only has access to a application specific `home-assistant` folder in the `App Folder` and cannot access any other parts of your OneDrive. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix grammatical error
Use "an" instead of "a" before "application".
-The integration only has access to a application specific `home-assistant` folder in the `App Folder` and cannot access any other parts of your OneDrive.
+The integration only has access to an application specific `home-assistant` folder in the `App Folder` and cannot access any other parts of your OneDrive.📝 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.
| The integration only has access to a application specific `home-assistant` folder in the `App Folder` and cannot access any other parts of your OneDrive. | |
| The integration only has access to an application specific `home-assistant` folder in the `App Folder` and cannot access any other parts of your OneDrive. |
🧰 Tools
🪛 LanguageTool
[misspelling] ~18-~18: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ive. The integration only has access to a application specific home-assistant f...
(EN_A_VS_AN)
c0ffeeca7
added
the
new-integration
Proposed change
SSIA
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Summary by CodeRabbit
New Features
Documentation