docs(api): set problem documentation namespace
This commit is contained in:
@@ -170,7 +170,7 @@ Every non-SSE error response uses RFC 9457 `application/problem+json` with:
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"type": "https://api.zarinpal.example/problems/validation-error",
|
"type": "https://zarinpal.amiirkhl.ir/docs/errors/validation-error",
|
||||||
"title": "Request validation failed",
|
"title": "Request validation failed",
|
||||||
"status": 422,
|
"status": 422,
|
||||||
"detail": "One or more request values are invalid.",
|
"detail": "One or more request values are invalid.",
|
||||||
@@ -277,11 +277,11 @@ Correlate `requestId`, authenticated user/merchant internal ids, run id, section
|
|||||||
- CSV uses UTF-8 with a BOM, Persian column names separated by normal spaces, and Persian status labels. Numeric cells remain plain calculation-safe numbers and timestamps remain UTC ISO values.
|
- CSV uses UTF-8 with a BOM, Persian column names separated by normal spaces, and Persian status labels. Numeric cells remain plain calculation-safe numbers and timestamps remain UTC ISO values.
|
||||||
- Analytics-access and CSV-export audit records are retained for 90 days and are accessible only to explicitly authorized backend operators; the MVP exposes no merchant audit-history surface.
|
- Analytics-access and CSV-export audit records are retained for 90 days and are accessible only to explicitly authorized backend operators; the MVP exposes no merchant audit-history surface.
|
||||||
- Detail responses and CSV exports show the existing opaque source terminal reference as `شناسه پایانه`; it is tenant-scoped trace data and never an authorization input.
|
- Detail responses and CSV exports show the existing opaque source terminal reference as `شناسه پایانه`; it is tenant-scoped trace data and never an authorization input.
|
||||||
|
- RFC 9457 problem `type` URIs use `https://zarinpal.amiirkhl.ir/docs/errors/{error-slug}` and resolve to human-readable error documentation.
|
||||||
|
|
||||||
## Remaining product questions
|
## Remaining product questions
|
||||||
|
|
||||||
1. Choose the production base URI used for dereferenceable Problem Details `type` documentation; `https://api.zarinpal.example/problems/...` is a non-production placeholder in the draft contract.
|
1. Approve or revise the proposed public-edge request limits: 16 KiB for JSON bodies and 8 KiB for the request target/query string.
|
||||||
2. Approve or revise the proposed public-edge request limits: 16 KiB for JSON bodies and 8 KiB for the request target/query string.
|
|
||||||
|
|
||||||
## Standards references
|
## Standards references
|
||||||
|
|
||||||
|
|||||||
@@ -676,7 +676,7 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Problem'
|
$ref: '#/components/schemas/Problem'
|
||||||
example:
|
example:
|
||||||
type: https://api.zarinpal.example/problems/unauthenticated
|
type: https://zarinpal.amiirkhl.ir/docs/errors/unauthenticated
|
||||||
title: Authentication required
|
title: Authentication required
|
||||||
status: 401
|
status: 401
|
||||||
detail: Sign in to continue.
|
detail: Sign in to continue.
|
||||||
@@ -706,7 +706,7 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Problem'
|
$ref: '#/components/schemas/Problem'
|
||||||
example:
|
example:
|
||||||
type: https://api.zarinpal.example/problems/resource-not-found
|
type: https://zarinpal.amiirkhl.ir/docs/errors/resource-not-found
|
||||||
title: Resource not found
|
title: Resource not found
|
||||||
status: 404
|
status: 404
|
||||||
detail: The requested resource is unavailable.
|
detail: The requested resource is unavailable.
|
||||||
@@ -747,7 +747,7 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Problem'
|
$ref: '#/components/schemas/Problem'
|
||||||
example:
|
example:
|
||||||
type: https://api.zarinpal.example/problems/export-too-large
|
type: https://zarinpal.amiirkhl.ir/docs/errors/export-too-large
|
||||||
title: Export is too large
|
title: Export is too large
|
||||||
status: 413
|
status: 413
|
||||||
detail: Narrow the approved filters and try again.
|
detail: Narrow the approved filters and try again.
|
||||||
@@ -777,7 +777,7 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/Problem'
|
$ref: '#/components/schemas/Problem'
|
||||||
example:
|
example:
|
||||||
type: https://api.zarinpal.example/problems/validation-error
|
type: https://zarinpal.amiirkhl.ir/docs/errors/validation-error
|
||||||
title: Request validation failed
|
title: Request validation failed
|
||||||
status: 422
|
status: 422
|
||||||
detail: One or more request values are invalid.
|
detail: One or more request values are invalid.
|
||||||
@@ -1704,7 +1704,7 @@ components:
|
|||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
format: uri
|
format: uri
|
||||||
description: Stable problem type URI; production base URI is pending approval.
|
description: Stable problem type URI under `https://zarinpal.amiirkhl.ir/docs/errors/{error-slug}`.
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
minLength: 1
|
minLength: 1
|
||||||
|
|||||||
Reference in New Issue
Block a user