Add missing fields in SDK types #17033
Conversation
* Add `endpoint_url` field to the component metadata, providing the URL to the HTTP interface of the component. * Add missing pagination fields to the `GetComponentsResponse` and `GetAccountsResponse` types.
jverce
added
bug
|
@jverce is attempting to deploy a commit to the Pipedreamers Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
WalkthroughThis update introduces version 1.6.8 of the SDK. It adds an optional Changes
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
packages/sdk/src/shared/index.tsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs packages/sdk/src/shared/component.tsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs 📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (4)
⏰ Context from checks skipped due to timeout of 90000ms (3)
🔇 Additional comments (5)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds pagination support to account and component list responses and exposes a new endpoint_url in component metadata.
- Extend
GetAccountsResponseandGetComponentsResponsewithPaginationResponse - Introduce optional
endpoint_urlfield inV1DeployedComponent - Bump SDK version to 1.6.8 and update changelog
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/sdk/src/shared/index.ts | Added PaginationResponse intersection to list response types |
| packages/sdk/src/shared/component.ts | Added optional endpoint_url field with documentation |
| packages/sdk/package.json | Bumped version from 1.6.7 to 1.6.8 |
| packages/sdk/CHANGELOG.md | Added entries for new pagination fields and endpoint_url |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (3)
packages/sdk/src/shared/index.ts:500
- The doc comment above GetAccountsResponse doesn't mention the added pagination fields (e.g., page, per_page, total). Consider updating it to reflect the new structure.
export type GetAccountsResponse = PaginationResponse & {
packages/sdk/src/shared/index.ts:500
- Add or update unit tests to verify that the pagination properties from PaginationResponse (page, per_page, total) are correctly handled in GetAccountsResponse and GetComponentsResponse.
export type GetAccountsResponse = PaginationResponse & {
packages/sdk/src/shared/component.ts:164
- Consider adding tests for the new endpoint_url field on V1DeployedComponent to ensure it's included and parsed correctly in component metadata.
endpoint_url?: string;
2 participants
Changelog
endpoint_urlfield to the component metadata, providing the URL to the HTTP interface of the component.GetComponentsResponseandGetAccountsResponsetypes.Summary by CodeRabbit