chore(docs): Generated API Reference (#2143)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
4961aece1c
commit
a1350bfaec
14
docs/api/admin/components/responses/400_error.yaml
Normal file
14
docs/api/admin/components/responses/400_error.yaml
Normal 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
|
||||
14
docs/api/admin/components/responses/500_error.yaml
Normal file
14
docs/api/admin/components/responses/500_error.yaml
Normal 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
|
||||
9
docs/api/admin/components/responses/default_error.yaml
Normal file
9
docs/api/admin/components/responses/default_error.yaml
Normal 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
|
||||
@@ -0,0 +1,7 @@
|
||||
description: User does not exist or incorrect credentials
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
default: Unauthorized
|
||||
example: Unauthorized
|
||||
@@ -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
|
||||
11
docs/api/admin/components/responses/invalid_state_error.yaml
Normal file
11
docs/api/admin/components/responses/invalid_state_error.yaml
Normal 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
|
||||
8
docs/api/admin/components/responses/not_found_error.yaml
Normal file
8
docs/api/admin/components/responses/not_found_error.yaml
Normal 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
|
||||
7
docs/api/admin/components/responses/unauthorized.yaml
Normal file
7
docs/api/admin/components/responses/unauthorized.yaml
Normal file
@@ -0,0 +1,7 @@
|
||||
description: User is not authorized. Must log in first
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
default: Unauthorized
|
||||
example: Unauthorized
|
||||
Reference in New Issue
Block a user