From cf02af06a482a2c1800f8122ab4386c9f181b8b4 Mon Sep 17 00:00:00 2001 From: iuwqyir Date: Thu, 3 Apr 2025 12:15:39 +0000 Subject: [PATCH] fix insight blueprints navigation (#6633) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## [Dashboard] Feature: Update API path format and add token lookup endpoint ## Notes for the reviewer This PR updates the API path format in `insightBlueprints.ts` to use curly braces for path parameters (e.g., changing `/v1/transactions/:contractAddress` to `/v1/transactions/{contractAddress}`). This standardizes our path format to match OpenAPI specifications. ## How to test The changes can be verified by checking the updated paths in the playground interface to ensure they display correctly with the new format. --- ## PR-Codex overview This PR focuses on updating the URL path parameters in the `insightBlueprints` to use curly braces `{}` instead of colons `:` for better clarity and consistency in API endpoints. ### Detailed summary - Changed path parameters from `:paramName` to `{paramName}` for various endpoints: - `/v1/transactions/:contractAddress` to `/v1/transactions/{contractAddress}` - `/v1/wallets/:wallet_address/transactions` to `/v1/wallets/{wallet_address}/transactions` - Updated multiple other endpoints similarly, including: - `/v1/events/:contractAddress` to `/v1/events/{contractAddress}` - `/v1/tokens/transfers/:contract_address` to `/v1/tokens/transfers/{contract_address}` - `/v1/nfts/:contract_address` to `/v1/nfts/{contract_address}` - And many more throughout the file. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` --- .../src/app/insight/insightBlueprints.ts | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/apps/playground-web/src/app/insight/insightBlueprints.ts b/apps/playground-web/src/app/insight/insightBlueprints.ts index 7d996fe5563..7f03b50d072 100644 --- a/apps/playground-web/src/app/insight/insightBlueprints.ts +++ b/apps/playground-web/src/app/insight/insightBlueprints.ts @@ -12,15 +12,15 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ }, { name: "Get contract transactions", - path: "/v1/transactions/:contractAddress", + path: "/v1/transactions/{contractAddress}", }, { name: "Get contract transactions with specific signature", - path: "/v1/transactions/:contractAddress/:signature", + path: "/v1/transactions/{contractAddress}/{signature}", }, { name: "Get wallet transactions", - path: "/v1/wallets/:wallet_address/transactions", + path: "/v1/wallets/{wallet_address}/transactions", }, ], }, @@ -34,11 +34,11 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ }, { name: "Get contract events", - path: "/v1/events/:contractAddress", + path: "/v1/events/{contractAddress}", }, { name: "Get contract events with specific signature", - path: "/v1/events/:contractAddress/:signature", + path: "/v1/events/{contractAddress}/{signature}", }, ], }, @@ -48,11 +48,11 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ paths: [ { name: "Get token transfers by transaction", - path: "/v1/tokens/transfers/transaction/:transaction_hash", + path: "/v1/tokens/transfers/transaction/{transaction_hash}", }, { name: "Get token transfers by contract", - path: "/v1/tokens/transfers/:contract_address", + path: "/v1/tokens/transfers/{contract_address}", }, { name: "Get token transfers by wallet address", @@ -60,15 +60,15 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ }, { name: "Get ERC-20 balances by address", - path: "/v1/tokens/erc20/:ownerAddress", + path: "/v1/tokens/erc20/{ownerAddress}", }, { name: "Get ERC-721 balances by address", - path: "/v1/tokens/erc721/:ownerAddress", + path: "/v1/tokens/erc721/{ownerAddress}", }, { name: "Get ERC-1155 balances by address", - path: "/v1/tokens/erc1155/:ownerAddress", + path: "/v1/tokens/erc1155/{ownerAddress}", }, { name: "Get supported tokens for price data", @@ -86,7 +86,7 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ paths: [ { name: "Resolve", - path: "/v1/resolve/:input", + path: "/v1/resolve/{input}", }, ], }, @@ -106,11 +106,11 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ paths: [ { name: "Get contract ABI​", - path: "/v1/contracts/abi/:contractAddress", + path: "/v1/contracts/abi/{contractAddress}", }, { name: "Get contract metadata​", - path: "/v1/contracts/metadata/:contractAddress", + path: "/v1/contracts/metadata/{contractAddress}", }, ], }, @@ -120,7 +120,7 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ paths: [ { name: "Unknown", - path: "/v1/decode/:contractAddress", + path: "/v1/decode/{contractAddress}", }, ], }, @@ -134,11 +134,11 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ }, { name: "Get NFT owners by contract", - path: "/v1/nfts/owners/:contract_address", + path: "/v1/nfts/owners/{contract_address}", }, { name: "Get NFT owners by token", - path: "/v1/nfts/owners/:contract_address/:token_id", + path: "/v1/nfts/owners/{contract_address}/{token_id}", }, { name: "Get NFT transfers by owner", @@ -146,31 +146,31 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ }, { name: "Get NFT transfers by transaction", - path: "/v1/nfts/transfers/transaction/:transaction_hash", + path: "/v1/nfts/transfers/transaction/{transaction_hash}", }, { name: "Get NFT transfers by contract", - path: "/v1/nfts/transfers/:contract_address", + path: "/v1/nfts/transfers/{contract_address}", }, { name: "Get NFTs by contract", - path: "/v1/nfts/:contract_address", + path: "/v1/nfts/{contract_address}", }, { name: "Get NFT transfers by token", - path: "/v1/nfts/transfers/:contract_address/:token_id", + path: "/v1/nfts/transfers/{contract_address}/{token_id}", }, { name: "Get NFT by token", - path: "/v1/nfts/:contract_address/:token_id", + path: "/v1/nfts/{contract_address}/{token_id}", }, { name: "Force refresh collection metadata", - path: "/v1/nfts/metadata/refresh/:contract_address", + path: "/v1/nfts/metadata/refresh/{contract_address}", }, { name: "Force refresh token metadata", - path: "/v1/nfts/metadata/refresh/:contract_address/:token_id", + path: "/v1/nfts/metadata/refresh/{contract_address}/{token_id}", }, ], }, @@ -180,7 +180,7 @@ export const insightBlueprints: MinimalBlueprintSpec[] = [ paths: [ { name: "Get wallet transactions", - path: "/v1/wallets/:wallet_address/transactions", + path: "/v1/wallets/{wallet_address}/transactions", }, ], },