change insight auth in docs #5681
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Your org has enabled the Graphite merge queue for merging into mainAdd the label “merge-queue” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix. You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link. |
github-actions
bot
added
the
Portal
iuwqyir
force-pushed
the
12-10-change_insight_auth_in_docs
branch
from
79eb0fb to
7fdc5be
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| const response = await fetch('https://1.insight.thirdweb.com/v1/<client-id>/events/0xdAC17F958D2ee523a2206206994597C13D831ec7/Transfer(address,address,uint256)?limit=5'); | ||
| const response = await fetch('https://1.insight.thirdweb.com/v1/events/0xdAC17F958D2ee523a2206206994597C13D831ec7/Transfer(address,address,uint256)?limit=5', { | ||
| headers: { | ||
| 'x-client-id': <YOUR_THIRDWEB_CLIENT_ID> |
There was a problem hiding this comment.
The x-client-id header value needs to be a string literal. Please wrap <YOUR_THIRDWEB_CLIENT_ID> in quotes:
'x-client-id': '<YOUR_THIRDWEB_CLIENT_ID>'Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5681 +/- ##
=======================================
Coverage 51.27% 51.27%
=======================================
Files 1092 1092
Lines 57346 57346
Branches 4685 4685
=======================================
Hits 29404 29404
Misses 27226 27226
Partials 716 716
*This pull request uses carry forward flags. Click here to find out more. |
size-limit report 📦
|
iuwqyir
force-pushed
the
12-10-change_insight_auth_in_docs
branch
from
7fdc5be to
eee5798
Compare
Merge activity
|
## Problem solved https://linear.app/thirdweb/issue/INSIGHT-480/improvements-required-for-insight-playground Updated the authentication method in the Insight API documentation to use the `x-client-id` header instead of embedding the client ID in the URL path. <!-- start pr-codex --> --- ## PR-Codex overview This PR updates the GitHub workflow and documentation related to the `insight` feature. It enhances the valid issue prefixes and provides clearer instructions for authentication in the API usage. ### Detailed summary - Updated `VALID_ISSUE_PREFIXES` to include `INSIGHT`. - Improved documentation in `apps/portal/src/app/insight/get-started/page.mdx`: - Corrected "clientId" to "client ID". - Added a note about using the `x-client-id` header for authentication. - Modified the API fetch request to include headers for `client ID`. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
joaquim-verges
force-pushed
the
12-10-change_insight_auth_in_docs
branch
from
eee5798 to
3f56252
Compare
Problem solved
https://linear.app/thirdweb/issue/INSIGHT-480/improvements-required-for-insight-playground
Updated the authentication method in the Insight API documentation to use the
x-client-idheader instead of embedding the client ID in the URL path.PR-Codex overview
This PR updates the configuration for issue prefixes and enhances the documentation for the
insightAPI usage, including a new authentication method.Detailed summary
VALID_ISSUE_PREFIXESto includeINSIGHT.client IDin thex-client-idheader orclientIdquery parameter.getUsdtTransfersfunction to include headers for authentication.