Spaces:
Sleeping
Sleeping
Commit
·
7d2d8f1
1
Parent(s):
b65ef75
update the readme file
Browse files
README.md
CHANGED
|
@@ -11,6 +11,8 @@
|
|
| 11 |
- [Overview](#overview)
|
| 12 |
- [Quick Start](#quick-start)
|
| 13 |
- [Features](#features)
|
|
|
|
|
|
|
| 14 |
- [Installation & Setup](#installation--setup)
|
| 15 |
- [Usage](#usage)
|
| 16 |
- [API Endpoints](#api-endpoints)
|
|
@@ -70,6 +72,8 @@ Then access:
|
|
| 70 |
- **FastAPI Docs**: `http://localhost:8000/docs`
|
| 71 |
- **Next.js Frontend** (optional): `cd frontend && npm install && npm run dev` → `http://localhost:3000`
|
| 72 |
|
|
|
|
|
|
|
| 73 |
---
|
| 74 |
|
| 75 |
## Features
|
|
@@ -364,6 +368,7 @@ All endpoints are served by the FastAPI backend at `http://localhost:8000`. Most
|
|
| 364 |
|
| 365 |
Most endpoints require:
|
| 366 |
- `x-tenant-id`: Tenant identifier for multi-tenant isolation
|
|
|
|
| 367 |
- `Content-Type: application/json`: For POST requests with JSON payloads
|
| 368 |
|
| 369 |
### Example Request
|
|
|
|
| 11 |
- [Overview](#overview)
|
| 12 |
- [Quick Start](#quick-start)
|
| 13 |
- [Features](#features)
|
| 14 |
+
- [Conversation Memory System](#conversation-memory-system)
|
| 15 |
+
- [Role-Based Access Control (RBAC)](#role-based-access-control-rbac)
|
| 16 |
- [Installation & Setup](#installation--setup)
|
| 17 |
- [Usage](#usage)
|
| 18 |
- [API Endpoints](#api-endpoints)
|
|
|
|
| 72 |
- **FastAPI Docs**: `http://localhost:8000/docs`
|
| 73 |
- **Next.js Frontend** (optional): `cd frontend && npm install && npm run dev` → `http://localhost:3000`
|
| 74 |
|
| 75 |
+
> **Security Note:** REST requests that hit protected endpoints must include both `x-tenant-id` and `x-user-role` headers. Roles (`viewer`, `editor`, `admin`, `owner`) determine which actions—such as document ingestion, rule uploads, or analytics access—the caller may perform.
|
| 76 |
+
|
| 77 |
---
|
| 78 |
|
| 79 |
## Features
|
|
|
|
| 368 |
|
| 369 |
Most endpoints require:
|
| 370 |
- `x-tenant-id`: Tenant identifier for multi-tenant isolation
|
| 371 |
+
- `x-user-role`: Caller role for RBAC enforcement (`viewer`, `editor`, `admin`, or `owner`)
|
| 372 |
- `Content-Type: application/json`: For POST requests with JSON payloads
|
| 373 |
|
| 374 |
### Example Request
|