mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
fcac837bd9
Revised multiple documentation files to replace instances of "FrikaMF" with "gregCore," reflecting the updated naming conventions and project structure. This change enhances consistency and clarity across the documentation, ensuring that users and contributors have accurate information regarding the framework and its components.
26 lines
1.0 KiB
Markdown
26 lines
1.0 KiB
Markdown
# DevServer API — beta channels (`gregframework.eu`)
|
|
|
|
This document defines the **intended** client contract for the gregCore **WorkshopUploader** “Betas” panel. The server may be implemented separately; keep URLs and tokens configurable.
|
|
|
|
## Base URL
|
|
|
|
- Default: `https://gregframework.eu`
|
|
- Override: user settings file next to the app (not committed to git).
|
|
|
|
## Endpoints (proposed)
|
|
|
|
| Method | Path | Purpose |
|
|
|--------|------|---------|
|
|
| `GET` | `/api/v1/betas` | List available beta channels (id, name, description). |
|
|
| `POST` | `/api/v1/betas/{id}/subscribe` | Enroll the current user (body: Steam ID or bearer token from OAuth). |
|
|
| `POST` | `/api/v1/betas/{id}/unsubscribe` | Leave a channel. |
|
|
|
|
## Authentication
|
|
|
|
- **Preferred:** Short-lived JWT after browser OAuth to `gregframework.eu`, stored in user settings.
|
|
- **Alternative:** Steam ID from Steamworks session in the WorkshopUploader process, plus server-side verification.
|
|
|
|
## Rate limiting and errors
|
|
|
|
Clients should show HTTP status and response body on failure; retry with backoff.
|