Files
unraid-docker-manager/.planning/milestones/v1.3-REQUIREMENTS.md
T
Lucas Berger 903e73d616 feat: v1.3 Unraid Update Status Sync
Unraid GraphQL API foundation — connectivity, authentication, and
container ID format verified for native Unraid API integration.

Phase 14: Unraid API Access (2 plans, 4 tasks)
- Established Unraid GraphQL API connectivity via myunraid.net cloud relay
- Dual credential storage (.env.unraid-api + n8n env vars)
- Container ID format: {server_hash}:{container_hash} (128-char SHA256 pair)
- Complete API contract documented in ARCHITECTURE.md
- "unraid" test command added to Telegram bot

Phases 15-16 dropped (superseded by v1.4 Unraid API Native).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-09 07:47:31 -05:00

60 lines
2.7 KiB
Markdown

# Requirements Archive: v1.3 Unraid Update Status Sync
**Archived:** 2026-02-09
**Status:** SHIPPED (descoped — Phase 14 only)
---
## v1.3 Requirements
Requirements for Unraid Update Status Sync.
### Infrastructure
- [x] **INFRA-01**: n8n container can reach Unraid GraphQL API endpoint — *Validated (Phase 14)*
- [x] **INFRA-02**: Unraid API key created with Docker update permission, stored securely — *Validated (Phase 14)*
- [x] **INFRA-03**: Container ID format verified via GraphQL query (document actual format) — *Validated (Phase 14, format: {server_hash}:{container_hash})*
### Sync — SUPERSEDED
*Dropped: Superseded by v1.4 Unraid API Native. When Unraid's GraphQL API replaces the Docker socket proxy for all container operations, the badge sync problem is eliminated — Unraid already knows about updates it performs.*
- [ ] **SYNC-01**: After bot updates a single container (text command), Unraid badge clears automatically — *Superseded*
- [ ] **SYNC-02**: After bot updates a single container (inline keyboard), Unraid badge clears automatically — *Superseded*
- [ ] **SYNC-03**: After batch "update all" operation, all updated containers sync to Unraid in one call — *Superseded*
- [ ] **SYNC-04**: After batch selection update, all selected containers sync to Unraid in one call — *Superseded*
- [ ] **SYNC-05**: Sync failure does not block or fail the container update itself (best-effort) — *Superseded*
- [ ] **SYNC-06**: User receives no false-positive Unraid update notifications for bot-updated containers — *Superseded*
### Documentation — DEFERRED
*Deferred to v1.4: Documentation will cover the full Unraid API Native migration rather than just sync.*
- [ ] **DOC-01**: README documents Unraid API setup (key creation, n8n container config) — *Deferred to v1.4*
- [ ] **DOC-02**: ARCHITECTURE.md documents Unraid sync integration (GraphQL API, data flow, new nodes) — *Partial (API contract documented in Phase 14), full integration docs deferred to v1.4*
## Traceability
| Requirement | Phase | Final Status |
|-------------|-------|--------------|
| INFRA-01 | Phase 14 | Validated |
| INFRA-02 | Phase 14 | Validated |
| INFRA-03 | Phase 14 | Validated |
| SYNC-01 | — | Superseded (v1.4) |
| SYNC-02 | — | Superseded (v1.4) |
| SYNC-03 | — | Superseded (v1.4) |
| SYNC-04 | — | Superseded (v1.4) |
| SYNC-05 | — | Superseded (v1.4) |
| SYNC-06 | — | Superseded (v1.4) |
| DOC-01 | — | Deferred (v1.4) |
| DOC-02 | Phase 14 (partial) | Deferred (v1.4) |
**Summary:**
- Validated: 3 (INFRA-01, INFRA-02, INFRA-03)
- Superseded: 6 (SYNC-01 through SYNC-06)
- Deferred: 2 (DOC-01, DOC-02)
---
*Requirements defined: 2026-02-08*
*Archived: 2026-02-09 — v1.3 shipped (descoped)*