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

docs(api): set problem documentation namespace

Browse Source
This commit is contained in:
Amirhossein Khalili
2026-08-20 18:24:26 +03:30
parent ee93460182
commit e54c8e8319
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/openapi.yaml
View File

@@ -676,7 +676,7 @@ components:
schema:
$ref: '#/components/schemas/Problem'
example:
type: https://api.zarinpal.example/problems/unauthenticated
type: https://zarinpal.amiirkhl.ir/docs/errors/unauthenticated
title: Authentication required
status: 401
detail: Sign in to continue.
@@ -706,7 +706,7 @@ components:
schema:
$ref: '#/components/schemas/Problem'
example:
type: https://api.zarinpal.example/problems/resource-not-found
type: https://zarinpal.amiirkhl.ir/docs/errors/resource-not-found
title: Resource not found
status: 404
detail: The requested resource is unavailable.
@@ -747,7 +747,7 @@ components:
schema:
$ref: '#/components/schemas/Problem'
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
status: 413
detail: Narrow the approved filters and try again.
@@ -777,7 +777,7 @@ components:
schema:
$ref: '#/components/schemas/Problem'
example:
type: https://api.zarinpal.example/problems/validation-error
type: https://zarinpal.amiirkhl.ir/docs/errors/validation-error
title: Request validation failed
status: 422
detail: One or more request values are invalid.
@@ -1704,7 +1704,7 @@ components:
type:
type: string
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:
type: string
minLength: 1