Add documentation to match new proxy view support #36747
Conversation
… that new proxy view.
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. |
📝 WalkthroughWalkthroughThe pull request modifies the documentation for the UniFi Protect integration, focusing on the removal of the Changes
Sequence DiagramsequenceDiagram
participant User
participant UniFiProtect
participant HomeAssistant
User->>UniFiProtect: Scan NFC Card/Fingerprint
UniFiProtect->>HomeAssistant: Trigger Event
HomeAssistant->>HomeAssistant: Validate Event ID
alt Valid ID
HomeAssistant->>User: Process Event
else Invalid/Unknown ID
HomeAssistant->>User: Log/Handle Accordingly
end
This sequence diagram illustrates the high-level flow of event processing for NFC card scans and fingerprint identification, highlighting the validation step and potential handling of unknown or invalid IDs. 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 (1)
source/_integrations/unifiprotect.markdown (1)
261-281: Documentation for proxy views needs clarification.The documentation states "four proxy views" but doesn't clearly enumerate them in a list format. Consider restructuring for better readability.
-Four URLs for proxy API endpoints: +The following four proxy API endpoints are available: + +1. Thumbnail endpoint: `/api/unifiprotect/thumbnail/{nvr_id}/{event_id}` - Proxies a JPEG event thumbnail from UniFi Protect. + +2. Event video endpoint: `/api/unifiprotect/video/{nvr_id}/{event_id}` - Proxies a MP4 video clip from UniFi Protect for a specific event... + +3. Snapshot endpoint: `/api/unifiprotect/snapshot/{nvr_id}/{camera_id}/{timestamp}` - Proxies a JPEG from UniFi Protect for a specific camera... + +4. Camera video endpoint: `/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}` - Proxies a MP4 video clip from UniFi Protect for a specific camera...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/unifiprotect.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/unifiprotect.markdown
[grammar] ~398-~398: Two determiners in a row. Choose either “the” or “a”.
Context: ...t provides a ulp_id, which represents the a internal user ID. If the fingerprint is...
(DT_DT)
⏰ 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 (1)
source/_integrations/unifiprotect.markdown (1)
389-389: LGTM: Clear security warning for NFC card scanning.The warning about validating scanned NFC IDs and the potential security implications of using third-party cards is well-documented and important for users to understand.
pull update from next
|
sorry about that - fixed up. |
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
source/_integrations/unifiprotect.markdown (1)
Line range hint
516-531: Consolidate duplicate fingerprint event warnings.There are two separate warning sections for fingerprint events with slightly different content. This duplication could lead to confusion and maintenance issues.
Consolidate the warnings into a single, comprehensive section that covers all the important points:
- Event triggering for both recognized and unrecognized fingerprints
- Lack of fingerprint ID for unknown fingerprints
- Potential for repeated event processing when device becomes unavailable/available
- Security considerations for device usage (e.g., door unlocking)
Also applies to: 533-539
🧰 Tools
🪛 LanguageTool
[uncategorized] ~295-~295: Possible missing comma found.
Context: ... media content from your Home Assistant instance so you can access thumbnails and video ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~317-~317: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...1-date-and-time-format.html).nvr_idcan either be the UniFi Protect ID of your ...(MISSING_IT_THERE)
🧹 Nitpick comments (1)
source/_integrations/unifiprotect.markdown (1)
295-315: Add comma for better readability.Add a comma after "instance" to improve readability and flow of the sentence.
-The {% term integrations %} provides four proxy views to proxy media content from your Home Assistant instance so you can access thumbnails and video clips +The {% term integrations %} provides four proxy views to proxy media content from your Home Assistant instance, so you can access thumbnails and video clips🧰 Tools
🪛 LanguageTool
[uncategorized] ~295-~295: Possible missing comma found.
Context: ... media content from your Home Assistant instance so you can access thumbnails and video ...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/unifiprotect.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/unifiprotect.markdown
[uncategorized] ~295-~295: Possible missing comma found.
Context: ... media content from your Home Assistant instance so you can access thumbnails and video ...
(AI_HYDRA_LEO_MISSING_COMMA)
Proposed change
Unifiprotect is getting a new proxy snapshot endpoint. This documents that new proxy view.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit