From 2fa9df497d09f9e955acd6f5a6b961e25e89da69 Mon Sep 17 00:00:00 2001 From: 0xsequence-bot <50996415+0xsequence-bot@users.noreply.github.com> Date: Wed, 8 Jan 2025 05:27:46 -0500 Subject: [PATCH] [AUTOMATED] Update relayer openapi docs (#442) * [AUTOMATED] Update: relayer/proto/docs/relayer.gen.yaml * [AUTOMATED] Update: docs/pages/api/**/*.gen.yaml * [AUTOMATED] Update: relayer/proto/docs/relayer.gen.yaml * [AUTOMATED] Update: relayer/proto/docs/relayer.gen.yaml * [AUTOMATED] Update: relayer/proto/docs/relayer.gen.yaml * [AUTOMATED] Update: relayer/proto/docs/relayer.gen.yaml --------- Co-authored-by: pkieltyka <18831+pkieltyka@users.noreply.github.com> Co-authored-by: VojtechVitek <139342+VojtechVitek@users.noreply.github.com> Co-authored-by: klaidliadon <5322228+klaidliadon@users.noreply.github.com> --- docs/pages/api/relayer/rpc.gen.yaml | 293 +++++++++++++++------------- 1 file changed, 159 insertions(+), 134 deletions(-) diff --git a/docs/pages/api/relayer/rpc.gen.yaml b/docs/pages/api/relayer/rpc.gen.yaml index 289576bb2c1..a4a9a23abd9 100644 --- a/docs/pages/api/relayer/rpc.gen.yaml +++ b/docs/pages/api/relayer/rpc.gen.yaml @@ -1,89 +1,91 @@ +# sequence-relayer v0.4.1 aa8b359d22b858519ecd4b5a7927f1241ed4f85b +# -- +# Code generated by webrpc-gen@v0.20.3 with openapi generator; DO NOT EDIT +# +# webrpc-gen -service=Relayer -match=@public -schema=proto/relayer.ridl -target=openapi -title=Relayer Api -servers=https://amoy-relayer.sequence.app;Amoy Relayer,https://apechain-relayer.sequence.app;Apechain Relayer,https://apechain-testnet-relayer.sequence.app;Apechain-Testnet Relayer,https://arbitrum-relayer.sequence.app;Arbitrum Relayer,https://arbitrum-nova-relayer.sequence.app;Arbitrum-Nova Relayer,https://arbitrum-sepolia-relayer.sequence.app;Arbitrum-Sepolia Relayer,https://avalanche-relayer.sequence.app;Avalanche Relayer,https://avalanche-testnet-relayer.sequence.app;Avalanche-Testnet Relayer,https://b3-relayer.sequence.app;B3 Relayer,https://b3-sepolia-relayer.sequence.app;B3-Sepolia Relayer,https://base-relayer.sequence.app;Base Relayer,https://base-sepolia-relayer.sequence.app;Base-Sepolia Relayer,https://blast-relayer.sequence.app;Blast Relayer,https://blast-sepolia-relayer.sequence.app;Blast-Sepolia Relayer,https://bsc-relayer.sequence.app;Bsc Relayer,https://bsc-testnet-relayer.sequence.app;Bsc-Testnet Relayer,https://gnosis-relayer.sequence.app;Gnosis Relayer,https://homeverse-relayer.sequence.app;Homeverse Relayer,https://homeverse-testnet-relayer.sequence.app;Homeverse-Testnet Relayer,https://immutable-zkevm-relayer.sequence.app;Immutable-Zkevm Relayer,https://immutable-zkevm-testnet-relayer.sequence.app;Immutable-Zkevm-Testnet Relayer,https://laos-relayer.sequence.app;Laos Relayer,https://laos-sigma-testnet-relayer.sequence.app;Laos-Sigma-Testnet Relayer,https://mainnet-relayer.sequence.app;Mainnet Relayer,https://optimism-relayer.sequence.app;Optimism Relayer,https://optimism-sepolia-relayer.sequence.app;Optimism-Sepolia Relayer,https://polygon-relayer.sequence.app;Polygon Relayer,https://polygon-zkevm-relayer.sequence.app;Polygon-Zkevm Relayer,https://rootnet-relayer.sequence.app;Rootnet Relayer,https://rootnet-porcini-relayer.sequence.app;Rootnet-Porcini Relayer,https://sepolia-relayer.sequence.app;Sepolia Relayer,https://skale-nebula-relayer.sequence.app;Skale-Nebula Relayer,https://skale-nebula-testnet-relayer.sequence.app;Skale-Nebula-Testnet Relayer,https://soneium-minato-relayer.sequence.app;Soneium-Minato Relayer,https://toy-testnet-relayer.sequence.app;Toy-Testnet Relayer,https://xai-relayer.sequence.app;Xai Relayer,https://xai-sepolia-relayer.sequence.app;Xai-Sepolia Relayer,https://xr-sepolia-relayer.sequence.app;Xr-Sepolia Relayer -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/relayer.gen.yaml openapi: 3.0.0 info: - title: Relayer Api + title: 'Relayer Api' version: '' servers: - - url: https://amoy-relayer.sequence.app - description: Amoy Relayer - - url: https://apechain-relayer.sequence.app - description: Apechain Relayer - - url: https://apechain-testnet-relayer.sequence.app - description: Apechain-Testnet Relayer - - url: https://arbitrum-relayer.sequence.app - description: Arbitrum Relayer - - url: https://arbitrum-nova-relayer.sequence.app - description: Arbitrum-Nova Relayer - - url: https://arbitrum-sepolia-relayer.sequence.app - description: Arbitrum-Sepolia Relayer - - url: https://avalanche-relayer.sequence.app - description: Avalanche Relayer - - url: https://avalanche-testnet-relayer.sequence.app - description: Avalanche-Testnet Relayer - - url: https://b3-relayer.sequence.app - description: B3 Relayer - - url: https://b3-sepolia-relayer.sequence.app - description: B3-Sepolia Relayer - - url: https://base-relayer.sequence.app - description: Base Relayer - - url: https://base-sepolia-relayer.sequence.app - description: Base-Sepolia Relayer - - url: https://blast-relayer.sequence.app - description: Blast Relayer - - url: https://blast-sepolia-relayer.sequence.app - description: Blast-Sepolia Relayer - - url: https://borne-testnet-relayer.sequence.app - description: Borne-Testnet Relayer - - url: https://bsc-relayer.sequence.app - description: Bsc Relayer - - url: https://bsc-testnet-relayer.sequence.app - description: Bsc-Testnet Relayer - - url: https://gnosis-relayer.sequence.app - description: Gnosis Relayer - - url: https://homeverse-relayer.sequence.app - description: Homeverse Relayer - - url: https://homeverse-testnet-relayer.sequence.app - description: Homeverse-Testnet Relayer - - url: https://immutable-zkevm-relayer.sequence.app - description: Immutable-Zkevm Relayer - - url: https://immutable-zkevm-testnet-relayer.sequence.app - description: Immutable-Zkevm-Testnet Relayer - - url: https://mainnet-relayer.sequence.app - description: Mainnet Relayer - - url: https://optimism-relayer.sequence.app - description: Optimism Relayer - - url: https://optimism-sepolia-relayer.sequence.app - description: Optimism-Sepolia Relayer - - url: https://polygon-relayer.sequence.app - description: Polygon Relayer - - url: https://polygon-zkevm-relayer.sequence.app - description: Polygon-Zkevm Relayer - - url: https://rootnet-relayer.sequence.app - description: Rootnet Relayer - - url: https://rootnet-porcini-relayer.sequence.app - description: Rootnet-Porcini Relayer - - url: https://sepolia-relayer.sequence.app - description: Sepolia Relayer - - url: https://skale-nebula-testnet-relayer.sequence.app - description: Skale-Nebula-Testnet Relayer - - url: https://soneium-minato-relayer.sequence.app - description: Soneium-Minato Relayer - - url: https://toy-testnet-relayer.sequence.app - description: Toy-Testnet Relayer - - url: https://xai-relayer.sequence.app - description: Xai Relayer - - url: https://xai-sepolia-relayer.sequence.app - description: Xai-Sepolia Relayer - - url: https://xr-sepolia-relayer.sequence.app - description: Xr-Sepolia Relayer + - url: 'https://amoy-relayer.sequence.app' + description: 'Amoy Relayer' + - url: 'https://apechain-relayer.sequence.app' + description: 'Apechain Relayer' + - url: 'https://apechain-testnet-relayer.sequence.app' + description: 'Apechain-Testnet Relayer' + - url: 'https://arbitrum-relayer.sequence.app' + description: 'Arbitrum Relayer' + - url: 'https://arbitrum-nova-relayer.sequence.app' + description: 'Arbitrum-Nova Relayer' + - url: 'https://arbitrum-sepolia-relayer.sequence.app' + description: 'Arbitrum-Sepolia Relayer' + - url: 'https://avalanche-relayer.sequence.app' + description: 'Avalanche Relayer' + - url: 'https://avalanche-testnet-relayer.sequence.app' + description: 'Avalanche-Testnet Relayer' + - url: 'https://b3-relayer.sequence.app' + description: 'B3 Relayer' + - url: 'https://b3-sepolia-relayer.sequence.app' + description: 'B3-Sepolia Relayer' + - url: 'https://base-relayer.sequence.app' + description: 'Base Relayer' + - url: 'https://base-sepolia-relayer.sequence.app' + description: 'Base-Sepolia Relayer' + - url: 'https://blast-relayer.sequence.app' + description: 'Blast Relayer' + - url: 'https://blast-sepolia-relayer.sequence.app' + description: 'Blast-Sepolia Relayer' + - url: 'https://bsc-relayer.sequence.app' + description: 'Bsc Relayer' + - url: 'https://bsc-testnet-relayer.sequence.app' + description: 'Bsc-Testnet Relayer' + - url: 'https://gnosis-relayer.sequence.app' + description: 'Gnosis Relayer' + - url: 'https://homeverse-relayer.sequence.app' + description: 'Homeverse Relayer' + - url: 'https://homeverse-testnet-relayer.sequence.app' + description: 'Homeverse-Testnet Relayer' + - url: 'https://immutable-zkevm-relayer.sequence.app' + description: 'Immutable-Zkevm Relayer' + - url: 'https://immutable-zkevm-testnet-relayer.sequence.app' + description: 'Immutable-Zkevm-Testnet Relayer' + - url: 'https://laos-relayer.sequence.app' + description: 'Laos Relayer' + - url: 'https://laos-sigma-testnet-relayer.sequence.app' + description: 'Laos-Sigma-Testnet Relayer' + - url: 'https://mainnet-relayer.sequence.app' + description: 'Mainnet Relayer' + - url: 'https://optimism-relayer.sequence.app' + description: 'Optimism Relayer' + - url: 'https://optimism-sepolia-relayer.sequence.app' + description: 'Optimism-Sepolia Relayer' + - url: 'https://polygon-relayer.sequence.app' + description: 'Polygon Relayer' + - url: 'https://polygon-zkevm-relayer.sequence.app' + description: 'Polygon-Zkevm Relayer' + - url: 'https://rootnet-relayer.sequence.app' + description: 'Rootnet Relayer' + - url: 'https://rootnet-porcini-relayer.sequence.app' + description: 'Rootnet-Porcini Relayer' + - url: 'https://sepolia-relayer.sequence.app' + description: 'Sepolia Relayer' + - url: 'https://skale-nebula-relayer.sequence.app' + description: 'Skale-Nebula Relayer' + - url: 'https://skale-nebula-testnet-relayer.sequence.app' + description: 'Skale-Nebula-Testnet Relayer' + - url: 'https://soneium-minato-relayer.sequence.app' + description: 'Soneium-Minato Relayer' + - url: 'https://toy-testnet-relayer.sequence.app' + description: 'Toy-Testnet Relayer' + - url: 'https://xai-relayer.sequence.app' + description: 'Xai Relayer' + - url: 'https://xai-sepolia-relayer.sequence.app' + description: 'Xai-Sepolia Relayer' + - url: 'https://xr-sepolia-relayer.sequence.app' + description: 'Xr-Sepolia Relayer' 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 + 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 @@ -95,13 +97,13 @@ components: properties: error: type: string - example: WebrpcEndpoint + example: "WebrpcEndpoint" code: type: number example: 0 msg: type: string - example: endpoint error + example: "endpoint error" cause: type: string status: @@ -117,13 +119,13 @@ components: properties: error: type: string - example: WebrpcRequestFailed + example: "WebrpcRequestFailed" code: type: number example: -1 msg: type: string - example: request failed + example: "request failed" cause: type: string status: @@ -139,13 +141,13 @@ components: properties: error: type: string - example: WebrpcBadRoute + example: "WebrpcBadRoute" code: type: number example: -2 msg: type: string - example: bad route + example: "bad route" cause: type: string status: @@ -161,13 +163,13 @@ components: properties: error: type: string - example: WebrpcBadMethod + example: "WebrpcBadMethod" code: type: number example: -3 msg: type: string - example: bad method + example: "bad method" cause: type: string status: @@ -183,13 +185,13 @@ components: properties: error: type: string - example: WebrpcBadRequest + example: "WebrpcBadRequest" code: type: number example: -4 msg: type: string - example: bad request + example: "bad request" cause: type: string status: @@ -205,13 +207,13 @@ components: properties: error: type: string - example: WebrpcBadResponse + example: "WebrpcBadResponse" code: type: number example: -5 msg: type: string - example: bad response + example: "bad response" cause: type: string status: @@ -227,13 +229,13 @@ components: properties: error: type: string - example: WebrpcServerPanic + example: "WebrpcServerPanic" code: type: number example: -6 msg: type: string - example: server panic + example: "server panic" cause: type: string status: @@ -249,13 +251,13 @@ components: properties: error: type: string - example: WebrpcInternalError + example: "WebrpcInternalError" code: type: number example: -7 msg: type: string - example: internal error + example: "internal error" cause: type: string status: @@ -271,13 +273,13 @@ components: properties: error: type: string - example: WebrpcClientDisconnected + example: "WebrpcClientDisconnected" code: type: number example: -8 msg: type: string - example: client disconnected + example: "client disconnected" cause: type: string status: @@ -293,13 +295,13 @@ components: properties: error: type: string - example: WebrpcStreamLost + example: "WebrpcStreamLost" code: type: number example: -9 msg: type: string - example: stream lost + example: "stream lost" cause: type: string status: @@ -315,13 +317,13 @@ components: properties: error: type: string - example: WebrpcStreamFinished + example: "WebrpcStreamFinished" code: type: number example: -10 msg: type: string - example: stream finished + example: "stream finished" cause: type: string status: @@ -337,13 +339,13 @@ components: properties: error: type: string - example: Unauthorized + example: "Unauthorized" code: type: number example: 1000 msg: type: string - example: Unauthorized access + example: "Unauthorized access" cause: type: string status: @@ -359,13 +361,13 @@ components: properties: error: type: string - example: PermissionDenied + example: "PermissionDenied" code: type: number example: 1001 msg: type: string - example: Permission denied + example: "Permission denied" cause: type: string status: @@ -381,18 +383,40 @@ components: properties: error: type: string - example: MethodNotFound + example: "MethodNotFound" code: type: number example: 1003 msg: type: string - example: Method not found + example: "Method not found" cause: type: string status: type: number example: 404 + ErrorRequestConflict: + type: object + required: + - error + - code + - msg + - status + properties: + error: + type: string + example: "RequestConflict" + code: + type: number + example: 1004 + msg: + type: string + example: "Conflict with target resource" + cause: + type: string + status: + type: number + example: 409 ErrorAborted: type: object required: @@ -403,13 +427,13 @@ components: properties: error: type: string - example: Aborted + example: "Aborted" code: type: number example: 1005 msg: type: string - example: Request aborted + example: "Request aborted" cause: type: string status: @@ -425,13 +449,13 @@ components: properties: error: type: string - example: Geoblocked + example: "Geoblocked" code: type: number example: 1006 msg: type: string - example: Geoblocked region + example: "Geoblocked region" cause: type: string status: @@ -447,13 +471,13 @@ components: properties: error: type: string - example: InvalidArgument + example: "InvalidArgument" code: type: number example: 2001 msg: type: string - example: Invalid argument + example: "Invalid argument" cause: type: string status: @@ -469,13 +493,13 @@ components: properties: error: type: string - example: Unavailable + example: "Unavailable" code: type: number example: 2002 msg: type: string - example: Unavailable resource + example: "Unavailable resource" cause: type: string status: @@ -491,13 +515,13 @@ components: properties: error: type: string - example: QueryFailed + example: "QueryFailed" code: type: number example: 2003 msg: type: string - example: Query failed + example: "Query failed" cause: type: string status: @@ -513,13 +537,13 @@ components: properties: error: type: string - example: NotFound + example: "NotFound" code: type: number example: 3000 msg: type: string - example: Resource not found + example: "Resource not found" cause: type: string status: @@ -535,13 +559,13 @@ components: properties: error: type: string - example: InsufficientFee + example: "InsufficientFee" code: type: number example: 3004 msg: type: string - example: Insufficient fee + example: "Insufficient fee" cause: type: string status: @@ -861,12 +885,12 @@ components: type: string txnArgs: type: object - description: map + description: 'map' additionalProperties: type: object txnReceipt: type: object - description: map + description: 'map' additionalProperties: type: object walletAddress: @@ -965,7 +989,7 @@ components: $ref: '#/components/schemas/TxnLogTransfer' users: type: object - description: map + description: 'map' additionalProperties: $ref: '#/components/schemas/TxnLogUser' timestamp: @@ -1163,7 +1187,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Relayer_GetChainID_Response' - 4XX: + '4XX': description: Client error content: application/json: @@ -1179,6 +1203,7 @@ paths: - $ref: '#/components/schemas/ErrorUnauthorized' - $ref: '#/components/schemas/ErrorPermissionDenied' - $ref: '#/components/schemas/ErrorMethodNotFound' + - $ref: '#/components/schemas/ErrorRequestConflict' - $ref: '#/components/schemas/ErrorAborted' - $ref: '#/components/schemas/ErrorGeoblocked' - $ref: '#/components/schemas/ErrorInvalidArgument' @@ -1186,7 +1211,7 @@ paths: - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorInsufficientFee' - 5XX: + '5XX': description: Server error content: application/json: @@ -1210,7 +1235,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Relayer_FeeTokens_Response' - 4XX: + '4XX': description: Client error content: application/json: @@ -1226,6 +1251,7 @@ paths: - $ref: '#/components/schemas/ErrorUnauthorized' - $ref: '#/components/schemas/ErrorPermissionDenied' - $ref: '#/components/schemas/ErrorMethodNotFound' + - $ref: '#/components/schemas/ErrorRequestConflict' - $ref: '#/components/schemas/ErrorAborted' - $ref: '#/components/schemas/ErrorGeoblocked' - $ref: '#/components/schemas/ErrorInvalidArgument' @@ -1233,7 +1259,7 @@ paths: - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorInsufficientFee' - 5XX: + '5XX': description: Server error content: application/json: @@ -1257,7 +1283,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Relayer_FeeOptions_Response' - 4XX: + '4XX': description: Client error content: application/json: @@ -1273,6 +1299,7 @@ paths: - $ref: '#/components/schemas/ErrorUnauthorized' - $ref: '#/components/schemas/ErrorPermissionDenied' - $ref: '#/components/schemas/ErrorMethodNotFound' + - $ref: '#/components/schemas/ErrorRequestConflict' - $ref: '#/components/schemas/ErrorAborted' - $ref: '#/components/schemas/ErrorGeoblocked' - $ref: '#/components/schemas/ErrorInvalidArgument' @@ -1280,7 +1307,7 @@ paths: - $ref: '#/components/schemas/ErrorQueryFailed' - $ref: '#/components/schemas/ErrorNotFound' - $ref: '#/components/schemas/ErrorInsufficientFee' - 5XX: + '5XX': description: Server error content: application/json: @@ -1289,5 +1316,3 @@ paths: - $ref: '#/components/schemas/ErrorWebrpcBadResponse' - $ref: '#/components/schemas/ErrorWebrpcServerPanic' - $ref: '#/components/schemas/ErrorWebrpcInternalError' -security: - - ApiKeyAuth: []