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

docs(api): approve merchant API contract

Browse Source
This commit is contained in:
Amirhossein Khalili
2026-08-20 18:27:07 +03:30
parent e8028d5f46
commit 520b39305d
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -29,4 +29,4 @@ The exact package layout is deferred until the Go architecture and DI decisions
## Merchant API contract ## 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/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. - [`docs/openapi.yaml`](docs/openapi.yaml) is the approved OpenAPI 3.1 interface source of truth for generated frontend types.

4
docs/API-SPEC.md
View File

@@ -1,6 +1,6 @@
# Merchant Analytics API Capability Spec # Merchant Analytics API Capability Spec
- Status: Draft for review — implementation not yet authorized - Status: Approved specification — implementation not yet authorized
- Capability: Merchant API - Capability: Merchant API
- Depends on: Approved Identity, Data Foundation, and Analytics Engine specifications - Depends on: Approved Identity, Data Foundation, and Analytics Engine specifications
- Interface source of truth: `docs/openapi.yaml` - Interface source of truth: `docs/openapi.yaml`
@@ -282,7 +282,7 @@ Correlate `requestId`, authenticated user/merchant internal ids, run id, section
## Remaining product questions ## Remaining product questions
None. Final approval of this complete capability spec and its OpenAPI contract remains the SDD gate before implementation planning. None.
## Standards references ## Standards references

6
docs/openapi.yaml
View File

@@ -1,11 +1,11 @@
openapi: 3.1.0 openapi: 3.1.0
info: info:
title: ZarinPal Merchant Analytics API title: ZarinPal Merchant Analytics API
version: 0.1.0-draft version: 1.0.0
summary: Contract-first API for authenticated merchant analytics. summary: Contract-first API for authenticated merchant analytics.
description: | description: |
Draft MVP interface. This document is the API source of truth; generated Approved MVP interface. This document is the API source of truth; generated
frontend types must come from this contract after approval. frontend types must come from this contract.
Merchant scope is always derived from the authenticated server-side session. Merchant scope is always derived from the authenticated server-side session.
No operation accepts a merchant identifier as authorization. All timestamps No operation accepts a merchant identifier as authorization. All timestamps