From 59f7ed5543b882c38b8075735a4c0b2ef35eeb86 Mon Sep 17 00:00:00 2001 From: Tobias Gesellchen Date: Fri, 5 Jun 2026 23:53:05 +0200 Subject: [PATCH] docs(architecture): cross-link the API route layout note (refs #451) - architecture/_index.md: list the section's docs with links. - reference/CLOUD-API.md: "See also" pointer (service cloud-emulation routes). - reference/API-ENDPOINTS.md: note distinguishing the speaker device API from the service route layout, with a link. Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/content/docs/architecture/_index.md | 9 +++++++++ docs/content/docs/reference/API-ENDPOINTS.md | 2 ++ docs/content/docs/reference/CLOUD-API.md | 2 ++ 3 files changed, 13 insertions(+) diff --git a/docs/content/docs/architecture/_index.md b/docs/content/docs/architecture/_index.md index b93fd3c..1adba74 100644 --- a/docs/content/docs/architecture/_index.md +++ b/docs/content/docs/architecture/_index.md @@ -2,3 +2,12 @@ title: "Architecture" weight: 5 --- + +Architecture notes and analyses: + +- [API Route Layout and Refactoring Plan](API-ROUTE-LAYOUT.md) - route + classification (frozen speaker contract vs our movable surface), the + actor / deployment / trust model, auth, and the staged plan toward the + `soundtouch-web` / `soundtouch-service` merge (issue #451). +- [Device-Local Install: Four User Journeys](DEVICE-LOCAL-INSTALL.md) - install + patterns and user journeys for on-device deployment. diff --git a/docs/content/docs/reference/API-ENDPOINTS.md b/docs/content/docs/reference/API-ENDPOINTS.md index 14e28d7..3b4ae51 100644 --- a/docs/content/docs/reference/API-ENDPOINTS.md +++ b/docs/content/docs/reference/API-ENDPOINTS.md @@ -3,6 +3,8 @@ title: "Bose SoundTouch Web API - Endpoints Overview" --- This document provides a comprehensive overview of the available API endpoints verified against the official Bose SoundTouch Web API v1.0 specification (January 7, 2026). +> **Note:** This documents the *speaker device* Web API (port 8090). For the AfterTouch *service's* own route layout (cloud emulation vs admin/control surface) and the planned refactoring, see [API Route Layout and Refactoring Plan](../architecture/API-ROUTE-LAYOUT.md). + **Acknowledgment**: Additional endpoints beyond the official API were discovered through the comprehensive [SoundTouch Plus Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API) maintained by the SoundTouch Plus community. Special thanks to @thlucas1 and contributors for documenting these working endpoints that enable full preset management and content navigation functionality. ## Implementation Status Legend diff --git a/docs/content/docs/reference/CLOUD-API.md b/docs/content/docs/reference/CLOUD-API.md index 7b3c72d..377a2a5 100644 --- a/docs/content/docs/reference/CLOUD-API.md +++ b/docs/content/docs/reference/CLOUD-API.md @@ -3,6 +3,8 @@ title: "Bose SoundTouch Cloud API Emulation (Marge/BMX/Stats)" --- This document describes the cloud-emulation APIs provided by the SoundTouch service. These APIs mimic the Bose cloud services (Marge, BMX, Stats) that SoundTouch devices and the SoundTouch controller application (Stockholm) interact with. +> **See also:** [API Route Layout and Refactoring Plan](../architecture/API-ROUTE-LAYOUT.md) - how these cloud-emulation routes are classified (frozen speaker contract vs our own movable surface) and the planned API consolidation toward a single binary. + ## Marge API (Account & Configuration) Base path: `/marge`