starcoach-hackathon/zarinpal-analytics-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: link merchant API contract

Browse Source
This commit is contained in:
Amirhossein Khalili
2026-08-20 18:08:53 +03:30
parent dfe88a148a
commit b031cfe280
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -25,3 +25,8 @@ One repository may expose several small `cmd/` entry points while sharing domain
- on-demand analytics worker that calculates dashboard sections in parallel and caches versioned results in Redis
The exact package layout is deferred until the Go architecture and DI decisions are approved.
## Merchant API contract
- [`docs/API-SPEC.md`](docs/API-SPEC.md) defines the reviewable MVP capability, security boundaries, SSE recovery, detail pagination, and CSV-export policy.
- [`docs/openapi.yaml`](docs/openapi.yaml) is the draft OpenAPI 3.1 interface source of truth and will generate frontend types after approval.