From a5de58b62116e5b0a4a673d0bdf7ee4267c7ad99 Mon Sep 17 00:00:00 2001 From: vsiskin Date: Fri, 10 Jan 2025 13:36:13 +0100 Subject: [PATCH] align error codes in assets api --- api-spec-v2.yaml | 189 +++++++++++++++++++++++++++-------------------- 1 file changed, 107 insertions(+), 82 deletions(-) diff --git a/api-spec-v2.yaml b/api-spec-v2.yaml index 6e73708..78afe92 100644 --- a/api-spec-v2.yaml +++ b/api-spec-v2.yaml @@ -4729,42 +4729,44 @@ paths: $ref: '#/components/schemas/AssetResponse' '400': description: | - - Listing an asset on the requested blockchain is not supported. Error code: 1000 + - Listing an asset on the requested blockchain is not supported. Error code: 1505 - - The asset address is invalid. Error code: 1003 + - The asset address is invalid. Error code: 1508 - - Self serve listing an asset on the requested blockchain is currently not supported, please contact support. Error code: 1004 + - Self serve listing an asset on the requested blockchain is currently not supported, please contact support. Error code: 1509 - - Blockchain is deprecated. Error code: 1006 + - Blockchain is deprecated. Error code: 1511 - - The asset's standard is not supported. Error code: 1007 + - The asset's standard is not supported. Error code: 1512 + + - Unable to get expected metadata: decimals | name | symbol. Error code: 1515 content: application/json: schema: $ref: '#/components/schemas/AssetBadRequestErrorResponse' '403': description: | - - The asset creation quota reached. Error code: 1005 + - The asset creation quota reached. Error code: 1510 - - Tenant is not allowed to create testnet assets. Error code: 1008 + - Tenant is not allowed to create testnet assets. Error code: 1513 - - Tenant is not allowed to create mainnet assets. Error code: 1009 + - Tenant is not allowed to create mainnet assets. Error code: 1514 content: application/json: schema: $ref: '#/components/schemas/AssetForbiddenErrorResponse' '404': description: | - - Invalid address, could not get asset information. Error code 1003 + - Invalid address, could not get asset information. Error code 1508 content: application/json: schema: $ref: '#/components/schemas/AssetNotFoundErrorResponse' '409': description: | - - The asset is already supported globally. Error code: 1001 + - The asset is already supported globally. Error code: 1506 - - The asset has already been added to this workspace. Error code: 1002 + - The asset has already been added to this workspace. Error code: 1507 content: application/json: schema: @@ -9011,18 +9013,21 @@ paths: schema: enum: - ETH - - ETH_TEST3 - ETH_TEST5 - ETH_TEST6 - POLYGON - POLYGON_TEST_MUMBAI - AMOY_POLYGON_TEST - BASECHAIN_ETH + - BASECHAIN_ETH_TEST5 - ETHERLINK - ETHERLINK_TEST - MANTLE - MANTLE_TEST - GUN_GUNZILLA_TEST + - ETH_SONEIUM + - SONEIUM_MINATO_TEST + - IOTX_IOTEX type: string - name: vaultAccountId required: true @@ -9072,11 +9077,16 @@ paths: - XTZ - XTZ_TEST - BASECHAIN_ETH + - BASECHAIN_ETH_TEST3 + - BASECHAIN_ETH_TEST5 - ETHERLINK - ETHERLINK_TEST - MANTLE - MANTLE_TEST - GUN_GUNZILLA_TEST + - ETH_SONEIUM + - SONEIUM_MINATO_TEST + - IOTX_IOTEX type: string - name: vaultAccountIds required: false @@ -12965,19 +12975,19 @@ components: vaultType: default: MPC description: >- - Type of vault account. The default type will be set to MPC.
- If the workspace does not support the selected type, it will return an error. + Type of vault account. The default type will be set to MPC.
+ If the workspace does not support the selected type, it will return an error. type: string enum: - - MPC - - KEY_LINK + - MPC + - KEY_LINK autoAssign: default: false description: >- - Applicable only when the vault account type is KEY_LINK. For MPC, this parameter will be ignored.
- If set to true and there are available keys, random keys will be assigned to the newly created vault account.
- If set to true and there are no available keys to be assigned, it will return an error.
- If set to false, the vault account will be created without any keys. + Applicable only when the vault account type is KEY_LINK. For MPC, this parameter will be ignored.
+ If set to true and there are available keys, random keys will be assigned to the newly created vault account.
+ If set to true and there are no available keys to be assigned, it will return an error.
+ If set to false, the vault account will be created without any keys. type: boolean VaultAccountsPagedResponse: type: object @@ -14019,45 +14029,45 @@ components: type: object properties: signingDeviceKeyId: - type: string - example: MyKey1 - maxLength: 256 - description: >- - The ID, name or label of the key specified on the customer's signing - device. + type: string + example: MyKey1 + maxLength: 256 + description: >- + The ID, name or label of the key specified on the customer's signing + device. signedCertPem: - type: string - example: "-----BEGIN CERTIFICATE ... END CERTIFICATE-----" - description: >- - The signed certificate that includes the public key PEM of the signing - key, signed by a validation key. + type: string + example: "-----BEGIN CERTIFICATE ... END CERTIFICATE-----" + description: >- + The signed certificate that includes the public key PEM of the signing + key, signed by a validation key. agentUserId: - type: string - minLength: 36 - maxLength: 36 - example: d18847b5-1df6-4c46-8f99-5cce47284529 - description: Id of user to which this key belongs + type: string + minLength: 36 + maxLength: 36 + example: d18847b5-1df6-4c46-8f99-5cce47284529 + description: Id of user to which this key belongs proofOfOwnership: - type: object - description: An object containing proof of ownership for the signing key. - properties: - message: - description: The message to be signed by the key as proof of ownership. 64 to 1024 bytes in hexadecimal format. - type: string - minLength: 64 - maxLength: 2048 - signature: - description: The signature of the message. 64 bytes in hexadecimal format. - type: string - minLength: 64 - maxLength: 128 - required: - - message - - signature + type: object + description: An object containing proof of ownership for the signing key. + properties: + message: + description: The message to be signed by the key as proof of ownership. 64 to 1024 bytes in hexadecimal format. + type: string + minLength: 64 + maxLength: 2048 + signature: + description: The signature of the message. 64 bytes in hexadecimal format. + type: string + minLength: 64 + maxLength: 128 + required: + - message + - signature required: - - signingDeviceKeyId - - signedCertPem - - agentUserId + - signingDeviceKeyId + - signedCertPem + - agentUserId ModifySigningKeyDto: type: object @@ -14512,7 +14522,7 @@ components: code: type: string description: Error code - example: 3001 + example: 1505 required: - message - code @@ -14526,7 +14536,7 @@ components: code: type: string description: Error code - example: 3006 + example: 1510 required: - message - code @@ -14540,7 +14550,7 @@ components: code: type: string description: Error code - example: 3009 + example: 1508 required: - message - code @@ -14554,7 +14564,7 @@ components: code: type: string description: Error code - example: 3002 + example: 1507 required: - message - code @@ -14568,7 +14578,7 @@ components: code: type: string description: Error code - example: 3005 + example: 0 required: - message - code @@ -15060,7 +15070,7 @@ components: `NODE_ROUTER` - used for transaction routing to a custom node `MEV` - used for transaction routing to a MEV protection provider type: string - enum: + enum: - MEV - NODE_ROUTER tag: @@ -19162,7 +19172,7 @@ components: amount: type: string example: '32' - description: | + description: | The number of tokens to unstake. This optional field is applicable only for liquid staking and allows for a partial unstake of the position. @@ -19376,7 +19386,7 @@ components: inProgress: false amount: "0.05" txId: c80601f4-d7b1-4795-a8ee-b09cdb5b450c - description: | + description: | An array of partial unstake requests for this position, relevant only for the Lido provider. Each object includes the status of the unstake request, a boolean indicating whether the action is in progress, the amount of tokens to unstake, and the transaction ID of the request. With Lido, a position may have multiple partial unstake requests in different states. This field is optional and not applicable for other providers. @@ -19402,26 +19412,26 @@ components: RelatedRequestDto: type: object properties: - status: - type: string - enum: - - deactivating - inProgress: - type: boolean - example: false - description: Indicates whether there is an ongoing action for this position related to this request - amount: - type: string - example: "0.05" - description: Amount of tokens to Unstake - txId: - type: string - example: c80601f4-d7b1-4795-a8ee-b09cdb5b450c - description: The transaction ID of the ongoing request + status: + type: string + enum: + - deactivating + inProgress: + type: boolean + example: false + description: Indicates whether there is an ongoing action for this position related to this request + amount: + type: string + example: "0.05" + description: Amount of tokens to Unstake + txId: + type: string + example: c80601f4-d7b1-4795-a8ee-b09cdb5b450c + description: The transaction ID of the ongoing request required: - - status - - inProgress - - amount + - status + - inProgress + - amount StakingGetAllDelegationsResponse: type: array items: @@ -19677,11 +19687,16 @@ components: - XTZ - XTZ_TEST - BASECHAIN_ETH + - BASECHAIN_ETH_TEST3 + - BASECHAIN_ETH_TEST5 - ETHERLINK - ETHERLINK_TEST - MANTLE - MANTLE_TEST - GUN_GUNZILLA_TEST + - ETH_SONEIUM + - SONEIUM_MINATO_TEST + - IOTX_IOTEX type: string description: description: Token's metadata description @@ -19781,11 +19796,16 @@ components: - XTZ - XTZ_TEST - BASECHAIN_ETH + - BASECHAIN_ETH_TEST3 + - BASECHAIN_ETH_TEST5 - ETHERLINK - ETHERLINK_TEST - MANTLE - MANTLE_TEST - GUN_GUNZILLA_TEST + - ETH_SONEIUM + - SONEIUM_MINATO_TEST + - IOTX_IOTEX description: description: Token's metadata description type: string @@ -19839,11 +19859,16 @@ components: - XTZ - XTZ_TEST - BASECHAIN_ETH + - BASECHAIN_ETH_TEST3 + - BASECHAIN_ETH_TEST5 - ETHERLINK - ETHERLINK_TEST - MANTLE - MANTLE_TEST - GUN_GUNZILLA_TEST + - ETH_SONEIUM + - SONEIUM_MINATO_TEST + - IOTX_IOTEX type: string description: Collection's blockchain contractAddress: