chore(docs): Generated API Reference (#2143)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-09-05 10:23:46 +03:00
committed by GitHub
parent 4961aece1c
commit a1350bfaec
662 changed files with 51365 additions and 29004 deletions

View File

@@ -0,0 +1,14 @@
description: Client Error or Multiple Errors
content:
application/json:
schema:
oneOf:
- $ref: ../schemas/error.yaml
- $ref: ../schemas/multiple_errors.yaml
examples:
not_allowed:
$ref: ../examples/not_allowed_error.yaml
invalid_data:
$ref: ../examples/invalid_data_error.yaml
multiple_errors:
$ref: ../examples/multiple_errors.yaml

View File

@@ -0,0 +1,14 @@
description: Server Error
content:
application/json:
schema:
$ref: ../schemas/error.yaml
examples:
database:
$ref: ../examples/database_error.yaml
unexpected_state:
$ref: ../examples/unexpected_state_error.yaml
invalid_argument:
$ref: ../examples/invalid_argument_error.yaml
default_error:
$ref: ../examples/default_error.yaml

View File

@@ -0,0 +1,9 @@
description: Default Error
content:
application/json:
schema:
$ref: ../schemas/error.yaml
example:
code: unknown_error
message: An unknown error occurred.
type: unknown_error

View File

@@ -0,0 +1,7 @@
description: User does not exist or incorrect credentials
content:
text/plain:
schema:
type: string
default: Unauthorized
example: Unauthorized

View File

@@ -0,0 +1,9 @@
description: Invalid Request Error
content:
application/json:
schema:
$ref: ../schemas/error.yaml
example:
code: invalid_request_error
message: Discount with code TEST already exists.
type: duplicate_error

View File

@@ -0,0 +1,11 @@
description: Invalid State Error
content:
application/json:
schema:
$ref: ../schemas/error.yaml
example:
code: unknown_error
message: >-
The request conflicted with another request. You may retry the request
with the provided Idempotency-Key.
type: QueryRunnerAlreadyReleasedError

View File

@@ -0,0 +1,8 @@
description: Not Found Error
content:
application/json:
schema:
$ref: ../schemas/error.yaml
example:
message: Entity with id 1 was not found
type: not_found

View File

@@ -0,0 +1,7 @@
description: User is not authorized. Must log in first
content:
text/plain:
schema:
type: string
default: Unauthorized
example: Unauthorized