From a99985ff48cf82005bc53fe2a27eae65b9e06e32 Mon Sep 17 00:00:00 2001 From: LukasJenicek <6400599+LukasJenicek@users.noreply.github.com> Date: Thu, 24 Oct 2024 09:01:29 +0000 Subject: [PATCH 1/3] [AUTOMATED] Update: api/proto/docs/api.gen.yaml --- docs/pages/api/api/api.gen.yaml | 1970 +++++++++++++++++++++++++++++++ 1 file changed, 1970 insertions(+) create mode 100644 docs/pages/api/api/api.gen.yaml diff --git a/docs/pages/api/api/api.gen.yaml b/docs/pages/api/api/api.gen.yaml new file mode 100644 index 00000000000..ab99f94a708 --- /dev/null +++ b/docs/pages/api/api/api.gen.yaml @@ -0,0 +1,1970 @@ +# sequence-api v0.4.0 200eea274dea56cdb887bc64168f72c7b08eeedd +# -- +# Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT +# +# webrpc-gen -service=API -match=@public -schema=proto/api.ridl -target=openapi -title=Sequence Api -servers=https://api.sequence.app/;Api -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, } -out=proto/docs/api.gen.yaml +openapi: 3.0.0 +info: + title: 'Sequence Api' + version: '' +servers: + - url: 'https://api.sequence.app/' + description: 'Api' +components: + securitySchemes: {'ApiKeyAuth': {'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key'}} + schemas: + ErrorWebrpcEndpoint: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcEndpoint" + code: + type: number + example: 0 + msg: + type: string + example: "endpoint error" + cause: + type: string + status: + type: number + example: 400 + ErrorWebrpcRequestFailed: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcRequestFailed" + code: + type: number + example: -1 + msg: + type: string + example: "request failed" + cause: + type: string + status: + type: number + example: 400 + ErrorWebrpcBadRoute: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcBadRoute" + code: + type: number + example: -2 + msg: + type: string + example: "bad route" + cause: + type: string + status: + type: number + example: 404 + ErrorWebrpcBadMethod: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcBadMethod" + code: + type: number + example: -3 + msg: + type: string + example: "bad method" + cause: + type: string + status: + type: number + example: 405 + ErrorWebrpcBadRequest: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcBadRequest" + code: + type: number + example: -4 + msg: + type: string + example: "bad request" + cause: + type: string + status: + type: number + example: 400 + ErrorWebrpcBadResponse: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcBadResponse" + code: + type: number + example: -5 + msg: + type: string + example: "bad response" + cause: + type: string + status: + type: number + example: 500 + ErrorWebrpcServerPanic: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcServerPanic" + code: + type: number + example: -6 + msg: + type: string + example: "server panic" + cause: + type: string + status: + type: number + example: 500 + ErrorWebrpcInternalError: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcInternalError" + code: + type: number + example: -7 + msg: + type: string + example: "internal error" + cause: + type: string + status: + type: number + example: 500 + ErrorWebrpcClientDisconnected: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcClientDisconnected" + code: + type: number + example: -8 + msg: + type: string + example: "client disconnected" + cause: + type: string + status: + type: number + example: 400 + ErrorWebrpcStreamLost: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcStreamLost" + code: + type: number + example: -9 + msg: + type: string + example: "stream lost" + cause: + type: string + status: + type: number + example: 400 + ErrorWebrpcStreamFinished: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "WebrpcStreamFinished" + code: + type: number + example: -10 + msg: + type: string + example: "stream finished" + cause: + type: string + status: + type: number + example: 200 + ErrorUnauthorized: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "Unauthorized" + code: + type: number + example: 1000 + msg: + type: string + example: "Unauthorized access" + cause: + type: string + status: + type: number + example: 401 + ErrorPermissionDenied: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "PermissionDenied" + code: + type: number + example: 1001 + msg: + type: string + example: "Permission denied" + cause: + type: string + status: + type: number + example: 403 + ErrorSessionExpired: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "SessionExpired" + code: + type: number + example: 1002 + msg: + type: string + example: "Session expired" + cause: + type: string + status: + type: number + example: 403 + ErrorAborted: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "Aborted" + code: + type: number + example: 1005 + msg: + type: string + example: "Request aborted" + cause: + type: string + status: + type: number + example: 400 + ErrorGeoblocked: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "Geoblocked" + code: + type: number + example: 1006 + msg: + type: string + example: "Geoblocked region" + cause: + type: string + status: + type: number + example: 451 + ErrorInvalidArgument: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "InvalidArgument" + code: + type: number + example: 2000 + msg: + type: string + example: "Invalid argument" + cause: + type: string + status: + type: number + example: 400 + ErrorUnavailable: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "Unavailable" + code: + type: number + example: 2002 + msg: + type: string + example: "Unavailable resource" + cause: + type: string + status: + type: number + example: 400 + ErrorQueryFailed: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "QueryFailed" + code: + type: number + example: 2003 + msg: + type: string + example: "Query failed" + cause: + type: string + status: + type: number + example: 400 + ErrorNotFound: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "NotFound" + code: + type: number + example: 3000 + msg: + type: string + example: "Resource not found" + cause: + type: string + status: + type: number + example: 400 + SortOrder: + type: string + description: Represented as uint32 on the server side + enum: + - DESC + - ASC + SardinePaymentType: + type: string + description: Represented as uint32 on the server side + enum: + - ach + - debit + - credit + - us_debit + - international_debit + - international_credit + SardineQuoteType: + type: string + description: Represented as uint32 on the server side + enum: + - buy + - sell + TokenType: + type: string + description: Represented as uint8 on the server side + enum: + - ERC20 + - ERC721 + - ERC1155 + Version: + type: object + required: + - webrpcVersion + - schemaVersion + - schemaHash + - appVersion + properties: + webrpcVersion: + type: string + schemaVersion: + type: string + schemaHash: + type: string + appVersion: + type: string + RuntimeStatus: + type: object + required: + - healthOK + - startTime + - uptime + - ver + - branch + - commitHash + - checks + - numTxnsRelayed + properties: + healthOK: + type: boolean + startTime: + type: string + uptime: + type: number + ver: + type: string + branch: + type: string + commitHash: + type: string + checks: + $ref: '#/components/schemas/RuntimeChecks' + numTxnsRelayed: + type: object + description: 'map' + additionalProperties: + $ref: '#/components/schemas/NumTxnsRelayed' + NumTxnsRelayed: + type: object + required: + - chainID + - prev + - current + - period + properties: + chainID: + type: number + prev: + type: number + current: + type: number + period: + type: number + RuntimeChecks: + type: object + SequenceContext: + type: object + required: + - factory + - mainModule + - mainModuleUpgradable + - guestModule + - utils + properties: + factory: + type: string + mainModule: + type: string + mainModuleUpgradable: + type: string + guestModule: + type: string + utils: + type: string + User: + type: object + required: + - address + - username + - normalizedUsername + - avatar + - bio + - location + - locale + - sysAdmin + properties: + address: + type: string + username: + type: string + normalizedUsername: + type: string + avatar: + type: string + bio: + type: string + location: + type: string + locale: + type: string + backup: + type: boolean + backupConfirmed: + type: boolean + maxInvites: + type: number + updatedAt: + type: string + createdAt: + type: string + sysAdmin: + type: boolean + WalletBackup: + type: object + required: + - accountAddress + - secretHash + - encryptedWallet + - userConfirmed + properties: + accountAddress: + type: string + secretHash: + type: string + encryptedWallet: + type: string + userConfirmed: + type: boolean + updatedAt: + type: string + createdAt: + type: string + Friend: + type: object + required: + - id + - userAddress + - friendAddress + - nickname + properties: + id: + type: number + userAddress: + type: string + friendAddress: + type: string + nickname: + type: string + user: + $ref: '#/components/schemas/User' + createdAt: + type: string + InviteCode: + type: object + required: + - code + - source + - usesLeft + - ownerAccount + - url + properties: + code: + type: string + source: + type: string + usesLeft: + type: number + ownerAccount: + type: string + email: + type: string + url: + type: string + createdAt: + type: string + expiresAt: + type: string + InviteCodeAccount: + type: object + required: + - code + - claimedByUserAddress + properties: + code: + type: string + claimedByUserAddress: + type: string + claimedAt: + type: string + InviteInfo: + type: object + required: + - expiryInHours + - max + - invites + properties: + expiryInHours: + type: number + max: + type: number + invites: + type: array + description: '[]InviteCode' + items: + $ref: '#/components/schemas/InviteCode' + ContractCall: + type: object + required: + - signature + - function + - args + properties: + signature: + type: string + function: + type: string + args: + type: array + description: '[]TupleComponent' + items: + $ref: '#/components/schemas/TupleComponent' + TupleComponent: + type: object + required: + - type + - value + properties: + name: + type: string + type: + type: string + value: + type: object + Transaction: + type: object + required: + - delegateCall + - revertOnError + - gasLimit + - target + - value + - data + properties: + delegateCall: + type: boolean + revertOnError: + type: boolean + gasLimit: + type: string + target: + type: string + value: + type: string + data: + type: string + call: + $ref: '#/components/schemas/ContractCall' + UserStorage: + type: object + required: + - userAddress + - key + - value + properties: + userAddress: + type: string + key: + type: string + value: + type: object + Token: + type: object + required: + - chainId + - contractAddress + properties: + chainId: + type: number + contractAddress: + type: string + tokenId: + type: string + Price: + type: object + required: + - value + - currency + properties: + value: + type: number + currency: + type: string + TokenPrice: + type: object + required: + - token + - floorPrice + - buyPrice + - sellPrice + - updatedAt + properties: + token: + $ref: '#/components/schemas/Token' + price: + $ref: '#/components/schemas/Price' + price24hChange: + $ref: '#/components/schemas/Price' + floorPrice: + $ref: '#/components/schemas/Price' + buyPrice: + $ref: '#/components/schemas/Price' + sellPrice: + $ref: '#/components/schemas/Price' + updatedAt: + type: string + ExchangeRate: + type: object + required: + - name + - symbol + - value + - vsCurrency + - currencyType + properties: + name: + type: string + symbol: + type: string + value: + type: number + vsCurrency: + type: string + currencyType: + type: string + LinkedWallet: + type: object + required: + - id + - walletAddress + - linkedWalletAddress + properties: + id: + type: number + walletType: + type: string + walletAddress: + type: string + linkedWalletAddress: + type: string + createdAt: + type: string + Page: + type: object + properties: + pageSize: + type: number + page: + type: number + totalRecords: + type: number + column: + type: string + before: + type: object + after: + type: object + sort: + type: array + description: '[]SortBy' + items: + $ref: '#/components/schemas/SortBy' + more: + type: boolean + SortBy: + type: object + required: + - column + - order + properties: + column: + type: string + order: + $ref: '#/components/schemas/SortOrder' + SardineNFTCheckoutParams: + type: object + required: + - name + - imageUrl + - network + - recipientAddress + - blockchainNftId + - contractAddress + - quantity + - tokenAmount + - tokenAddress + - tokenSymbol + - calldata + - platform + properties: + name: + type: string + imageUrl: + type: string + network: + type: string + recipientAddress: + type: string + blockchainNftId: + type: string + contractAddress: + type: string + quantity: + type: number + decimals: + type: number + tokenAmount: + type: string + tokenAddress: + type: string + tokenSymbol: + type: string + tokenDecimals: + type: number + calldata: + type: string + platform: + type: string + approvedSpenderAddress: + type: string + SardineNFTCheckout: + type: object + required: + - token + - expiresAt + - orderId + properties: + token: + type: string + expiresAt: + type: string + orderId: + type: string + SardineOrder: + type: object + required: + - id + - referenceId + - status + - fiatCurrency + - fiatExchangeRateUSD + - transactionId + - total + - subTotal + - transactionFee + - networkFee + - transactionType + - name + - price + - imageUrl + - recipientAddress + properties: + id: + type: string + createdAt: + type: string + referenceId: + type: string + status: + type: string + fiatCurrency: + type: string + fiatExchangeRateUSD: + type: number + transactionId: + type: string + expiresAt: + type: string + total: + type: number + subTotal: + type: number + transactionFee: + type: number + networkFee: + type: number + paymentCurrency: + type: string + paymentMethodType: + type: string + transactionType: + type: string + name: + type: string + price: + type: number + imageUrl: + type: string + contractAddress: + type: string + transactionHash: + type: string + recipientAddress: + type: string + SardineRegion: + type: object + required: + - countryCode + - isAllowedOnRamp + - isAllowedOnNFT + - isBasicKycRequired + - isSsnRequired + - name + - currencyCode + - isPayrollSupported + - supportedDocuments + - paymentMethods + - states + properties: + countryCode: + type: string + isAllowedOnRamp: + type: boolean + isAllowedOnNFT: + type: boolean + isBasicKycRequired: + type: array + description: '[]string' + items: + type: string + isSsnRequired: + type: array + description: '[]string' + items: + type: string + name: + type: string + currencyCode: + type: string + isPayrollSupported: + type: boolean + supportedDocuments: + type: array + description: '[]string' + items: + type: string + paymentMethods: + type: array + description: '[]SardineRegionPaymentMethod' + items: + $ref: '#/components/schemas/SardineRegionPaymentMethod' + states: + type: array + description: '[]SardineRegionState' + items: + $ref: '#/components/schemas/SardineRegionState' + SardineRegionPaymentMethod: + type: object + required: + - name + - isAllowedOnRamp + - isAllowedOnNFT + - subTypes + - type + - subType + properties: + name: + type: string + isAllowedOnRamp: + type: boolean + isAllowedOnNFT: + type: boolean + subTypes: + type: array + description: '[]string' + items: + type: string + type: + type: string + subType: + type: string + SardineRegionState: + type: object + required: + - code + - name + - isAllowedOnRamp + - isAllowedOnNFT + properties: + code: + type: string + name: + type: string + isAllowedOnRamp: + type: boolean + isAllowedOnNFT: + type: boolean + SardineSupportedToken: + type: object + required: + - network + - assetSymbol + - assetName + - chainId + - tokenName + - token + - tokenAddress + properties: + network: + type: string + assetSymbol: + type: string + assetName: + type: string + chainId: + type: string + tokenName: + type: string + token: + type: string + tokenAddress: + type: string + SardineEnabledToken: + type: object + required: + - network + - assetSymbol + - assetName + - chainId + - tokenName + - token + - tokenAddress + properties: + network: + type: string + assetSymbol: + type: string + assetName: + type: string + chainId: + type: string + tokenName: + type: string + token: + type: string + tokenAddress: + type: string + SardineGetQuoteParams: + type: object + required: + - assetType + - network + - total + properties: + assetType: + type: string + network: + type: string + total: + type: number + currency: + type: string + paymentType: + $ref: '#/components/schemas/SardinePaymentType' + quoteType: + $ref: '#/components/schemas/SardineQuoteType' + walletAddress: + type: string + SardineQuote: + type: object + required: + - quantity + - network + - assetType + - total + - currency + - expiresAt + - paymentType + - price + - subtotal + - transactionFee + - networkFee + - highNetworkFee + - minTransactionValue + - maxTransactionValue + - liquidityProvider + properties: + quantity: + type: number + network: + type: string + assetType: + type: string + total: + type: number + currency: + type: string + expiresAt: + type: string + paymentType: + type: string + price: + type: number + subtotal: + type: number + transactionFee: + type: number + networkFee: + type: number + highNetworkFee: + type: boolean + minTransactionValue: + type: number + maxTransactionValue: + type: number + liquidityProvider: + type: string + SardineFiatCurrency: + type: object + required: + - currencyCode + - name + - currencySymbol + - paymentOptions + - supportingCountries + properties: + currencyCode: + type: string + name: + type: string + currencySymbol: + type: string + paymentOptions: + type: array + description: '[]SardinePaymentOption' + items: + $ref: '#/components/schemas/SardinePaymentOption' + supportingCountries: + type: array + description: '[]string' + items: + type: string + SardinePaymentOption: + type: object + required: + - name + - dailyLimit + - weeklyLimit + - monthlyLimit + - maxAmount + - minAmount + - subTypes + - type + - subType + - processingTime + properties: + name: + type: string + dailyLimit: + type: number + weeklyLimit: + type: number + monthlyLimit: + type: number + maxAmount: + type: number + minAmount: + type: number + subTypes: + type: array + description: '[]string' + items: + type: string + type: + type: string + subType: + type: string + processingTime: + type: string + SwapPrice: + type: object + required: + - currencyAddress + - currencyBalance + - price + - transactionValue + properties: + currencyAddress: + type: string + currencyBalance: + type: string + price: + type: string + transactionValue: + type: string + SwapQuote: + type: object + required: + - currencyAddress + - currencyBalance + - price + - maxPrice + - to + - transactionData + - transactionValue + - approveData + properties: + currencyAddress: + type: string + currencyBalance: + type: string + price: + type: string + maxPrice: + type: string + to: + type: string + transactionData: + type: string + transactionValue: + type: string + approveData: + type: string + CurrencyGroup: + type: object + required: + - name + - tokens + properties: + name: + type: string + tokens: + type: array + description: '[]CurrencyGroupToken' + items: + $ref: '#/components/schemas/CurrencyGroupToken' + CurrencyGroupToken: + type: object + required: + - chainId + - tokenAddress + properties: + chainId: + type: number + tokenAddress: + type: string + OffchainInventory: + type: object + required: + - id + - projectId + - chainId + - externalProductId + - paymentTokenAddress + - paymentTokenType + - paymentTokenId + - paymentAmount + - paymentRecipient + - createdAt + properties: + id: + type: number + projectId: + type: number + chainId: + type: number + externalProductId: + type: string + paymentTokenAddress: + type: string + paymentTokenType: + $ref: '#/components/schemas/TokenType' + paymentTokenId: + type: number + paymentAmount: + type: number + paymentRecipient: + type: string + chainedCallAddress: + type: string + chainedCallData: + type: string + allowCrossChainPayments: + type: boolean + callbackURL: + type: string + createdAt: + type: string + deletedAt: + type: string + OffchainPayment: + type: object + required: + - id + - offchainInventoryId + - productRecipient + - paymentChainId + - paymentTokenAddress + - expiration + - createdAt + properties: + id: + type: number + offchainInventoryId: + type: number + productRecipient: + type: string + paymentChainId: + type: number + paymentTokenAddress: + type: string + expiration: + type: string + createdAt: + type: string + completedAt: + type: string + processedAt: + type: string + PaymentResponse: + type: object + required: + - paymentId + - offchainInventoryId + - chainId + - externalProductId + - paymentTokenAddress + - paymentTokenType + - paymentTokenId + - paymentTotal + - expiration + - signature + - txTo + - txData + properties: + paymentId: + type: number + offchainInventoryId: + type: number + chainId: + type: number + externalProductId: + type: string + paymentTokenAddress: + type: string + paymentTokenType: + $ref: '#/components/schemas/TokenType' + paymentTokenId: + type: number + paymentTotal: + type: number + expiration: + type: string + signature: + type: string + txTo: + type: string + txData: + type: string + API_IsValidSignature_Request: + type: object + properties: + chainId: + type: string + walletAddress: + type: string + digest: + type: string + signature: + type: string + API_IsValidMessageSignature_Request: + type: object + properties: + chainId: + type: string + walletAddress: + type: string + message: + type: string + signature: + type: string + API_IsValidTypedDataSignature_Request: + type: object + properties: + chainId: + type: string + walletAddress: + type: string + typedData: + type: object + signature: + type: string + API_IsValidETHAuthProof_Request: + type: object + properties: + chainId: + type: string + walletAddress: + type: string + ethAuthProofString: + type: string + API_LinkWallet_Request: + type: object + properties: + parentWalletAddress: + type: string + parentWalletMessage: + type: string + parentWalletSignature: + type: string + linkedWalletAddress: + type: string + linkedWalletMessage: + type: string + linkedWalletSignature: + type: string + signatureChainId: + type: string + linkedWalletType: + type: string + API_GetLinkedWallets_Request: + type: object + properties: + parentWalletAddress: + type: string + parentWalletMessage: + type: string + parentWalletSignature: + type: string + signatureChainId: + type: string + API_RemoveLinkedWallet_Request: + type: object + properties: + parentWalletAddress: + type: string + parentWalletMessage: + type: string + parentWalletSignature: + type: string + linkedWalletAddress: + type: string + linkedWalletMessage: + type: string + linkedWalletSignature: + type: string + signatureChainId: + type: string + API_GetSwapQuote_Request: + type: object + properties: + userAddress: + type: string + buyCurrencyAddress: + type: string + sellCurrencyAddress: + type: string + buyAmount: + type: string + chainId: + type: number + includeApprove: + type: boolean + API_IsValidSignature_Response: + type: object + properties: + isValid: + type: boolean + API_IsValidMessageSignature_Response: + type: object + properties: + isValid: + type: boolean + API_IsValidTypedDataSignature_Response: + type: object + properties: + isValid: + type: boolean + API_IsValidETHAuthProof_Response: + type: object + properties: + isValid: + type: boolean + API_LinkWallet_Response: + type: object + properties: + status: + type: boolean + API_GetLinkedWallets_Response: + type: object + properties: + linkedWallets: + type: array + description: '[]LinkedWallet' + items: + $ref: '#/components/schemas/LinkedWallet' + API_RemoveLinkedWallet_Response: + type: object + properties: + status: + type: boolean + API_GetSwapQuote_Response: + type: object + properties: + swapQuote: + $ref: '#/components/schemas/SwapQuote' +paths: + /rpc/API/IsValidSignature: + post: + summary: IsValidSignature + description: "TODO: we can add walletContext optional in the future when we need it NOTE: chainId can be either a number or canonical name" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/API_IsValidSignature_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/API_IsValidSignature_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/API/IsValidMessageSignature: + post: + summary: IsValidMessageSignature + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/API_IsValidMessageSignature_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/API_IsValidMessageSignature_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/API/IsValidTypedDataSignature: + post: + summary: IsValidTypedDataSignature + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/API_IsValidTypedDataSignature_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/API_IsValidTypedDataSignature_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/API/IsValidETHAuthProof: + post: + summary: IsValidETHAuthProof + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/API_IsValidETHAuthProof_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/API_IsValidETHAuthProof_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/API/LinkWallet: + post: + summary: LinkWallet + description: " Linked wallets (v0 -- simple support) " + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/API_LinkWallet_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/API_LinkWallet_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/API/GetLinkedWallets: + post: + summary: GetLinkedWallets + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/API_GetLinkedWallets_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/API_GetLinkedWallets_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/API/RemoveLinkedWallet: + post: + summary: RemoveLinkedWallet + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/API_RemoveLinkedWallet_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/API_RemoveLinkedWallet_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' + /rpc/API/GetSwapQuote: + post: + summary: GetSwapQuote + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/API_GetSwapQuote_Request' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/API_GetSwapQuote_Response' + '4XX': + description: Client error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcEndpoint' + - $ref: '#/components/schemas/ErrorWebrpcRequestFailed' + - $ref: '#/components/schemas/ErrorWebrpcBadRoute' + - $ref: '#/components/schemas/ErrorWebrpcBadMethod' + - $ref: '#/components/schemas/ErrorWebrpcBadRequest' + - $ref: '#/components/schemas/ErrorWebrpcClientDisconnected' + - $ref: '#/components/schemas/ErrorWebrpcStreamLost' + - $ref: '#/components/schemas/ErrorUnauthorized' + - $ref: '#/components/schemas/ErrorPermissionDenied' + - $ref: '#/components/schemas/ErrorSessionExpired' + - $ref: '#/components/schemas/ErrorAborted' + - $ref: '#/components/schemas/ErrorGeoblocked' + - $ref: '#/components/schemas/ErrorInvalidArgument' + - $ref: '#/components/schemas/ErrorUnavailable' + - $ref: '#/components/schemas/ErrorQueryFailed' + - $ref: '#/components/schemas/ErrorNotFound' + '5XX': + description: Server error + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/ErrorWebrpcBadResponse' + - $ref: '#/components/schemas/ErrorWebrpcServerPanic' + - $ref: '#/components/schemas/ErrorWebrpcInternalError' From 2b8dcfbccafa18538cdb17f2ba742f9bd98b8a98 Mon Sep 17 00:00:00 2001 From: Lukas Jenicek Date: Thu, 24 Oct 2024 11:02:59 +0200 Subject: [PATCH 2/3] add api --- .github/workflows/scheme.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/scheme.yml b/.github/workflows/scheme.yml index 0c65fe8092a..d10234d0a3c 100644 --- a/.github/workflows/scheme.yml +++ b/.github/workflows/scheme.yml @@ -28,6 +28,7 @@ jobs: go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}, {"BearerAuth":[]}]' docs/pages/api/metadata/metadata.gen.yaml go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/indexer/indexer.gen.yaml go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/relayer/relayer.gen.yaml + go run github.com/mikefarah/yq/v4 -e -i '.security=[{"ApiKeyAuth":[]}]' docs/pages/api/api/api.gen.yaml - name: Push changes uses: 0xsequence/actions/git-commit@master From 70c4b9e87fc08f63549b8d8863021d15c9107b19 Mon Sep 17 00:00:00 2001 From: LukasJenicek <6400599+LukasJenicek@users.noreply.github.com> Date: Thu, 24 Oct 2024 09:04:39 +0000 Subject: [PATCH 3/3] [AUTOMATED] Update: docs/pages/api/**/*.gen.yaml --- docs/pages/api/api/api.gen.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/pages/api/api/api.gen.yaml b/docs/pages/api/api/api.gen.yaml index ab99f94a708..c8bdda12f9f 100644 --- a/docs/pages/api/api/api.gen.yaml +++ b/docs/pages/api/api/api.gen.yaml @@ -1968,3 +1968,5 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - $ref: '#/components/schemas/ErrorWebrpcInternalError' +security: + - ApiKeyAuth: []