github/Bose-SoundTouch
1
0
Fork 0
mirror of https://github.com/gesellix/Bose-SoundTouch.git synced 2026-08-19 00:56:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(architecture): cross-link the API route layout note (refs #451)

Browse Source 
- 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) <noreply@anthropic.com>
This commit is contained in:
Tobias Gesellchen
2026-06-06 19:11:24 +02:00
co-authored by Claude Opus 4.8
parent b4b23a3716
commit 59f7ed5543
3 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/docs/architecture/_index.md
+9
View File
@@ -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.
docs/content/docs/reference/API-ENDPOINTS.md
+2
View File
@@ -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
docs/content/docs/reference/CLOUD-API.md
+2
View File
@@ -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`