Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 53 additions & 2 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

55 changes: 53 additions & 2 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions openapi/components/schemas/errors/Error401.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,17 @@ properties:
|------------|-------------|
| UNAUTHORIZED | Issue with API credentials |
| INVALID_SIGNATURE | Signature header is invalid |
| WALLET_SIGNATURE_MISSING | The `Grid-Wallet-Signature` header is required for this Embedded Wallet action but was not supplied |
| WALLET_SIGNATURE_MALFORMED | The `Grid-Wallet-Signature` header could not be parsed (bad encoding, structure, or fields) |
| WALLET_SIGNATURE_BODY_MISMATCH | The `Grid-Wallet-Signature` was computed over a different request body than the one received |
| WALLET_SIGNATURE_INVALID | The `Grid-Wallet-Signature` failed cryptographic verification against the registered credential |
enum:
- UNAUTHORIZED
- INVALID_SIGNATURE
- WALLET_SIGNATURE_MISSING
- WALLET_SIGNATURE_MALFORMED
- WALLET_SIGNATURE_BODY_MISMATCH
- WALLET_SIGNATURE_INVALID
message:
type: string
description: Error message
Expand Down
2 changes: 2 additions & 0 deletions openapi/components/schemas/errors/Error404.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ properties:
| TOKEN_NOT_FOUND | Token not found |
| BULK_UPLOAD_JOB_NOT_FOUND | Bulk upload job not found |
| REFERENCE_NOT_FOUND | Reference not found |
| UMA_NOT_FOUND | The UMA address is well-formed but no receiver exists at the counterparty VASP |
enum:
- TRANSACTION_NOT_FOUND
- INVITATION_NOT_FOUND
Expand All @@ -31,6 +32,7 @@ properties:
- TOKEN_NOT_FOUND
- BULK_UPLOAD_JOB_NOT_FOUND
- REFERENCE_NOT_FOUND
- UMA_NOT_FOUND
message:
type: string
description: Error message
Expand Down
26 changes: 26 additions & 0 deletions openapi/components/schemas/errors/Error405.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
type: object
required:
- message
- status
- code
properties:
status:
type: integer
enum:
- 405
description: HTTP status code
code:
type: string
description: |
| Error Code | Description |
|------------|-------------|
| METHOD_NOT_ALLOWED | The HTTP method is not supported for this endpoint |
enum:
- METHOD_NOT_ALLOWED
message:
type: string
description: Error message
details:
type: object
description: Additional error details
additionalProperties: true
2 changes: 2 additions & 0 deletions openapi/components/schemas/errors/Error409.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ properties:
| UMA_ADDRESS_EXISTS | UMA address already exists |
| EMAIL_OTP_EMAIL_ALREADY_EXISTS | Email address is already associated with an EMAIL_OTP credential |
| EMAIL_OTP_CREDENTIAL_SET_CHANGED | Tied EMAIL_OTP credential set changed after the signed-retry challenge was issued |
| CONFLICT | Generic resource-state conflict. Returned, for example, when `platformCustomerId` on a customer create call collides with an existing active customer on the same platform |
enum:
- TRANSACTION_NOT_PENDING_PLATFORM_APPROVAL
- UMA_ADDRESS_EXISTS
- EMAIL_OTP_EMAIL_ALREADY_EXISTS
- EMAIL_OTP_CREDENTIAL_SET_CHANGED
- CONFLICT
message:
type: string
description: Error message
Expand Down
21 changes: 20 additions & 1 deletion openapi/paths/customers/customers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,19 @@ post:
application/json:
schema:
$ref: ../../components/schemas/errors/Error401.yaml
'405':
description: >-
Method not allowed. Returned (as JSON, not HTML) when the request
uses an HTTP method that is not supported on this path.
content:
application/json:
schema:
$ref: ../../components/schemas/errors/Error405.yaml
'409':
description: Conflict - Customer with the UMA address already exists
description: >-
Conflict. `UMA_ADDRESS_EXISTS` when the requested UMA address is
already taken; `CONFLICT` when `platformCustomerId` collides with
an existing active customer on the same platform.
content:
application/json:
schema:
Expand Down Expand Up @@ -219,6 +230,14 @@ get:
application/json:
schema:
$ref: ../../components/schemas/errors/Error401.yaml
'405':
description: >-
Method not allowed. Returned (as JSON, not HTML) when the request
uses an HTTP method that is not supported on this path.
content:
application/json:
schema:
$ref: ../../components/schemas/errors/Error405.yaml
'500':
description: Internal service error
content:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ get:
schema:
$ref: ../../../components/schemas/errors/Error401.yaml
'404':
description: UMA address not found
description: >-
UMA address not found. The address is well-formed but no receiver
exists at the counterparty VASP (`UMA_NOT_FOUND`).
content:
application/json:
schema:
Expand All @@ -72,4 +74,4 @@ get:
content:
application/json:
schema:
$ref: ../../../components/schemas/errors/Error500.yaml
$ref: ../../../components/schemas/errors/Error500.yaml
Loading