docs: update service READMEs for refactor progress and stale phase references
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -5,18 +5,19 @@ Python/FastAPI gateway to the IPFS-backed document archival store. Upload, retri
|
||||
**Port:** `8082` (container: `bp-compliance-dsms-gateway`)
|
||||
**Stack:** Python 3.11, FastAPI, IPFS (Kubo via `dsms-node`).
|
||||
|
||||
## Architecture (target — Phase 4)
|
||||
## Architecture
|
||||
|
||||
`main.py` (467 LOC) will split into:
|
||||
Phase 4 refactor is complete. `main.py` is now a thin 41-LOC entry point:
|
||||
|
||||
```
|
||||
dsms_gateway/
|
||||
├── main.py # FastAPI app factory, <50 LOC
|
||||
├── routers/ # /documents, /legal-documents, /verify, /node
|
||||
├── ipfs/ # IPFS client wrapper
|
||||
├── services/ # Business logic (archive, verify)
|
||||
├── schemas/ # Pydantic models
|
||||
└── config.py
|
||||
dsms-gateway/
|
||||
├── main.py # FastAPI app factory, 41 LOC
|
||||
├── routers/
|
||||
│ ├── documents.py # /documents, /legal-documents, /verify routes
|
||||
│ └── node.py # /node routes
|
||||
├── models.py # Pydantic models
|
||||
├── dependencies.py # Shared FastAPI dependencies
|
||||
└── config.py # Settings
|
||||
```
|
||||
|
||||
See `../AGENTS.python.md`.
|
||||
@@ -36,7 +37,7 @@ uvicorn main:app --reload --port 8082
|
||||
pytest test_main.py -v
|
||||
```
|
||||
|
||||
Note: the existing test file is larger than the implementation — good coverage already. Phase 4 splits both into matching module pairs.
|
||||
27/27 tests pass. Test coverage matches the current module structure.
|
||||
|
||||
## Public API surface
|
||||
|
||||
|
||||
Reference in New Issue
Block a user