mirror of
git://f0xx.org/android_cast
synced 2026-07-29 04:18:09 +03:00
docs updated, most probably related to pdf gen and/or url shortener
This commit is contained in:
@@ -10,6 +10,8 @@ _Validated: 2026-06-10 after FE `apps.conf` consolidation + BE sync. Public base
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Table of contents
|
||||
|
||||
<!-- toc -->
|
||||
@@ -39,6 +41,7 @@ _Validated: 2026-06-10 after FE `apps.conf` consolidation + BE sync. Public base
|
||||
- [Publish (operator)](#publish-operator)
|
||||
- [Heartbeat (device)](#heartbeat-device)
|
||||
- [Auth & account security](#auth-account-security)
|
||||
- [URL shortener (preview — not deployed)](#url-shortener-preview-not-deployed)
|
||||
- [Non-HTTP services](#non-http-services)
|
||||
- [Validation scripts](#validation-scripts)
|
||||
<!-- /toc -->
|
||||
@@ -327,6 +330,27 @@ Flow doc: [20260607-2FA-email-mobile-auth-flow.md](20260607-2FA-email-mobile-aut
|
||||
|
||||
---
|
||||
|
||||
## URL shortener (preview — not deployed)
|
||||
|
||||
**Web:** [https://s.f0xx.org](https://s.f0xx.org) (dedicated vhost; FE TLS live)
|
||||
|
||||
| Kind | Path | Notes |
|
||||
|------|------|--------|
|
||||
| Health | `GET /api/v1/health` | Stub until PHP handlers deployed |
|
||||
| Shorten | `POST /api/v1/shorten` | Bearer token; see SPEC |
|
||||
| QR | `GET /api/v1/qr/{slug}.png` | PNG |
|
||||
| Redirect | `GET /{slug}` | `302` → original URL |
|
||||
|
||||
Spec: [specs/20100611_3_url_shortener.md](specs/20100611_3_url_shortener.md) · scaffold: [backend/url-shortener/](../backend/url-shortener/)
|
||||
|
||||
```bash
|
||||
export BASE=https://s.f0xx.org
|
||||
curl -sS "$BASE/api/v1/health"
|
||||
# Full cookbook: backend/url-shortener/scripts/demo_curl.sh (needs BEARER when live)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Non-HTTP services
|
||||
|
||||
| Service | Access | Used by |
|
||||
|
||||
Reference in New Issue
Block a user