docs(auth,devices): Beam WO5 batch 3 — 15 endpoints backfilled, registry pinned

Beam backfilled auth core (login/register/refresh/logout/profile) and devices
core (list/update/delete/shelf CRUD/sidecar/register flow) with frontmatter,
provenance, and labeled examples. All claimed shapes verified against
handlers: AuthResponse {access_token, refresh_token omitempty, token_type,
expires_in, user}, update device {device_updated, device}, shelf wrappers,
DeviceAuthStatusResponse.

Claude registry verification: 15 entries pinned by type (LoginRequest,
RegisterRequest, AuthResponse, RefreshTokenRequest/Response, UserProfile,
DeviceListResponse, DeviceUpdateRequest, AddToShelfRequest, SidecarConfig,
DeviceRegistrationRequest/Response, DeviceAuthStatusRequest/Response).
Removed revoke_device.md — name-only duplicate of delete_device.md (same
DELETE /api/devices/:id route; was the last audit-orphan doc).

Gate catches this round (subtle Go serialization facts, now pinned in docs):
- uuid.UUID arrays never serialize as omitted: register/status response
  ALWAYS carries device_id (all-zeros while pending) despite omitempty
- update device request binds device_name, not name
- register response includes device_id alongside registration_id
- list devices response is a {devices, total} wrapper
This commit is contained in:
John O'Keefe committed 2026-10-24 15:48:18 -04:00
1 parent eacc33bfac
commit ae9588f1c6
17 files changed
+278 -103

No files matched your search

+10 -3
View File
@@ -1,3 +1,11 @@
---
method: POST
path: /api/auth/login
auth: none
area: authentication
---
<!-- source: internal/handlers/auth.go:378 AuthHandler.Login -->
# Login User
Authenticate with email and password.
@@ -15,7 +23,7 @@ Authenticate with email and password.
### Example Request
```json
```json example-request
{
"login": "user@example.com",
"password": "SecureP@ss123!"
@@ -24,10 +32,9 @@ Authenticate with email and password.
## Response (200 OK)
```json
```json example-response
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"refresh_token": "d4f5g6h7...",
"token_type": "Bearer",
"expires_in": 604800,
"user": {
+14 -2
View File
@@ -1,3 +1,11 @@
---
method: POST
path: /api/auth/logout
auth: none
area: authentication
---
<!-- source: internal/handlers/refresh_token.go:76 AuthHandler.Logout -->
# Logout User
Invalidate the current JWT token.
@@ -19,9 +27,13 @@ POST /api/auth/logout
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```
## Response (204 No Content)
## Response (200 OK)
No response body.
```json example-response
{
"message": "logged out successfully"
}
```
## Error Responses
@@ -1,3 +1,11 @@
---
method: POST
path: /api/auth/refresh
auth: none
area: authentication
---
<!-- source: internal/handlers/refresh_token.go:36 AuthHandler.RefreshAccessToken -->
# Refresh Token
Obtain a new JWT access token using a refresh token.
@@ -14,7 +22,7 @@ Obtain a new JWT access token using a refresh token.
### Example Request
```json
```json example-request
{
"refresh_token": "d4f5g6h7..."
}
@@ -22,7 +30,7 @@ Obtain a new JWT access token using a refresh token.
## Response (200 OK)
```json
```json example-response
{
"access_token": "new-jwt-token",
"token_type": "Bearer",
+12 -7
View File
@@ -1,3 +1,11 @@
---
method: POST
path: /api/auth/register
auth: none
area: authentication
---
<!-- source: internal/handlers/auth.go:153 AuthHandler.Register -->
# Register User
Create a new user account.
@@ -18,7 +26,7 @@ Create a new user account.
### Example Request
```json
```json example-request
{
"email": "user@example.com",
"username": "john",
@@ -30,10 +38,9 @@ Create a new user account.
## Response (201 Created)
```json
```json example-response
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"refresh_token": "d4f5g6h7...",
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 604800,
"user": {
@@ -42,9 +49,7 @@ Create a new user account.
"username": "john",
"first_name": "John",
"last_name": "Doe",
"role": "user",
"theme": "tokyo-night",
"created_at": "2026-01-31T10:00:00Z"
"role": "user"
}
}
```