This repository has been archived by the owner on Jun 6, 2023. It is now read-only.
fix(chart.getPanels): make the query params optional #477
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When the array is empty, the SDK strips the query param from the query, so the schema doesn't type check
NickdeK
reviewed
Mar 20, 2023
| @@ -22,10 +22,10 @@ type Panel = { | |||
| }; | |||
|
|
|||
| type Request = { | |||
| body: Record<KindsResources, Array<{ | |||
| body: Partial<Record<KindsResources, Array<{ | |||
There was a problem hiding this comment.
I'm not sure if this is what we want; how can the api update panels if the contents of the request body is optional?
There was a problem hiding this comment.
here it will update nothing, I think
| @@ -13,7 +13,7 @@ const kindsResources = ['pinGroups', 'pins'] as const; | |||
| type KindsResources = typeof kindsResources[number]; | |||
|
|
|||
| type Request = { | |||
| query: Record<KindsHashIds, Array<HashId>>; | |||
| query: Partial<Record<KindsHashIds, Array<HashId>>>; | |||
There was a problem hiding this comment.
Talked about this on the chat with @Arinono where I voiced my concerns what we would expect if the query is optional. In this case it would mean it would return all panels, that could be fine?
There was a problem hiding this comment.
I think it will mean that we give back nothing.
Arinono
deleted the
fix-platform-client-2151-sentry-error-preserve-graphs
branch
github-actions bot
pushed a commit
that referenced
this pull request
Mar 20, 2023
## [18.3.1](v18.3.0...v18.3.1) (2023-03-20) ### Bug Fixes * **chart.getPanels:** make the query params optional ([#477](#477)) ([6fc8754](6fc8754))
|
🎉 This PR is included in version 18.3.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
authors
@Arinono
issues
refs withthegrid/platform-client#2151
used by https://github.com/withthegrid/platform-client/pull/2152
used by https://github.com/withthegrid/platform-sdk-private/pull/281
used by https://github.com/withthegrid/platform/pull/2081
impl details
When the array is empty, the SDK strips the query param from the query, so the schema doesn't type check