Revise README for BlackRoadAdd detailed README with API Gateway description, table, and roadmap OS API Gateway

Updated the README to reflect the new API Gateway structure and purpose, adding sections for short and long descriptions, a structured table, and a roadmap board.
This commit is contained in:
Alexa Amundson
2025-11-17 17:56:58 -06:00
committed by GitHub
parent 0824f8923c
commit 10c359eba8

View File

@@ -1,2 +1,38 @@
# blackroad-os-api # BlackRoad OS — API Gateway
Create a minimal Operator service skeleton: - app/: FastAPI or plain Python entrypoint with a /health endpoint - workers/: placeholder module for background jobs and agent orchestration - infra/: Dockerfile, requirements.txt, and a sample railway.toml with no secrets Use simple placeholder code only. Do not add complex business logic.
## Short Description
Unified FastAPI backend for routing, auth, services, and shared API contracts.
## Long Description
API Gateway is the canonical service defining routes, schemas, validation, identity tokens, auth flows, and service-to-service communication. Every other component — Web, Prism, Core, Operator — calls into this.
## Structured Table
| Field | Value |
| -------------- | --------------------------------------- |
| **Purpose** | Routing, shared schemas, identity, auth |
| **Depends On** | None (root backend) |
| **Used By** | All components |
| **Owner** | Cece + Alexa |
| **Status** | Active — always evolving |
## Roadmap Board (API)
Columns:
* **Schema Planning**
* **Routes**
* **Auth**
* **Testing**
* **Deploy**
* **Stable**
Sample tasks:
* /health and version endpoints
* Identity/token lifecycle
* Route coverage expansion
* Agent protocol endpoints
* Pocket OS API handler