diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index 6a2a8401..dd086e0a 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -424,8 +424,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Error401' + '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/Error405' '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: @@ -551,6 +557,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error401' + '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/Error405' '500': description: Internal service error content: @@ -2179,7 +2191,7 @@ paths: schema: $ref: '#/components/schemas/Error401' '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: @@ -8057,9 +8069,17 @@ components: |------------|-------------| | 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 @@ -8909,6 +8929,33 @@ components: totalCount: type: integer description: Total number of customers matching the criteria (excluding pagination) + Error405: + 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 CustomerCreateRequest: type: object required: @@ -8985,11 +9032,13 @@ components: | 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 @@ -9022,6 +9071,7 @@ components: | 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 @@ -9031,6 +9081,7 @@ components: - TOKEN_NOT_FOUND - BULK_UPLOAD_JOB_NOT_FOUND - REFERENCE_NOT_FOUND + - UMA_NOT_FOUND message: type: string description: Error message diff --git a/openapi.yaml b/openapi.yaml index 6a2a8401..dd086e0a 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -424,8 +424,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Error401' + '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/Error405' '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: @@ -551,6 +557,12 @@ paths: application/json: schema: $ref: '#/components/schemas/Error401' + '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/Error405' '500': description: Internal service error content: @@ -2179,7 +2191,7 @@ paths: schema: $ref: '#/components/schemas/Error401' '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: @@ -8057,9 +8069,17 @@ components: |------------|-------------| | 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 @@ -8909,6 +8929,33 @@ components: totalCount: type: integer description: Total number of customers matching the criteria (excluding pagination) + Error405: + 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 CustomerCreateRequest: type: object required: @@ -8985,11 +9032,13 @@ components: | 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 @@ -9022,6 +9071,7 @@ components: | 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 @@ -9031,6 +9081,7 @@ components: - TOKEN_NOT_FOUND - BULK_UPLOAD_JOB_NOT_FOUND - REFERENCE_NOT_FOUND + - UMA_NOT_FOUND message: type: string description: Error message diff --git a/openapi/components/schemas/errors/Error401.yaml b/openapi/components/schemas/errors/Error401.yaml index d92fb3b7..508f56ba 100644 --- a/openapi/components/schemas/errors/Error401.yaml +++ b/openapi/components/schemas/errors/Error401.yaml @@ -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 diff --git a/openapi/components/schemas/errors/Error404.yaml b/openapi/components/schemas/errors/Error404.yaml index d53ff414..3f4cab3b 100644 --- a/openapi/components/schemas/errors/Error404.yaml +++ b/openapi/components/schemas/errors/Error404.yaml @@ -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 @@ -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 diff --git a/openapi/components/schemas/errors/Error405.yaml b/openapi/components/schemas/errors/Error405.yaml new file mode 100644 index 00000000..fd25307a --- /dev/null +++ b/openapi/components/schemas/errors/Error405.yaml @@ -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 diff --git a/openapi/components/schemas/errors/Error409.yaml b/openapi/components/schemas/errors/Error409.yaml index 160abb37..09db54cb 100644 --- a/openapi/components/schemas/errors/Error409.yaml +++ b/openapi/components/schemas/errors/Error409.yaml @@ -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 diff --git a/openapi/paths/customers/customers.yaml b/openapi/paths/customers/customers.yaml index e8a9923b..c0eddd2c 100644 --- a/openapi/paths/customers/customers.yaml +++ b/openapi/paths/customers/customers.yaml @@ -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: @@ -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: diff --git a/openapi/paths/receiver/uma/receiver_uma_{receiverUmaAddress}.yaml b/openapi/paths/receiver/uma/receiver_uma_{receiverUmaAddress}.yaml index 15e211a4..05ca56b8 100644 --- a/openapi/paths/receiver/uma/receiver_uma_{receiverUmaAddress}.yaml +++ b/openapi/paths/receiver/uma/receiver_uma_{receiverUmaAddress}.yaml @@ -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: @@ -72,4 +74,4 @@ get: content: application/json: schema: - $ref: ../../../components/schemas/errors/Error500.yaml \ No newline at end of file + $ref: ../../../components/schemas/errors/Error500.yaml