[TOOL-2801] Insight Playground: Use OpenAPIV3 types #5804
Merged
Conversation
This file contains hidden or 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Member
Author
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Contributor
size-limit report 📦
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5804 +/- ##
=======================================
Coverage 53.34% 53.34%
=======================================
Files 1101 1101
Lines 59124 59124
Branches 4825 4824 -1
=======================================
Hits 31541 31541
Misses 26864 26864
Partials 719 719
*This pull request uses carry forward flags. Click here to find out more. |
MananTank
changed the title
MananTank
changed the title
joaquim-verges
approved these changes
Dec 19, 2024
Contributor
Merge activity
|
MananTank
added a commit
that referenced
this pull request
Dec 19, 2024
## Problem solved
Short description of the bug fixed or feature added
<!-- start pr-codex -->
---
## PR-Codex overview
This PR introduces the `openapi-types` package and updates the handling of OpenAPI specifications in the dashboard application. It enhances type safety and flexibility in managing API parameters and responses.
### Detailed summary
- Added `openapi-types` dependency.
- Updated `blueprintSpec` to use `OpenAPIV3.Document`.
- Modified parameter handling in `BlueprintPlaygroundUI` to filter and process OpenAPI parameters.
- Enhanced type definitions for `BlueprintParameter` using `OpenAPIV3.ParameterObject`.
- Updated rendering logic in `BlueprintCard` to handle optional descriptions and titles.
- Refactored utility functions to align with new OpenAPI types.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
MananTank
force-pushed
the
12-19-_tool-2800_use_openapiv3_types_in_insight_playground
branch
from
9174ffa to
216f069
Compare
## Problem solved
Short description of the bug fixed or feature added
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on enhancing the handling of OpenAPI specifications within the codebase, improving type definitions, and refining the UI components to accommodate optional fields and better manage parameters.
### Detailed summary
- Added `openapi-types` dependency in `package.json`.
- Updated `blueprintSpec` to use optional chaining for safer access.
- Modified `BlueprintCard` to handle optional `description` and `title`.
- Changed `BlueprintParameter` type to use `OpenAPIV3.ParameterObject`.
- Enhanced `BlueprintPlaygroundUI` to filter and manage parameters more effectively.
- Updated parameter handling in forms to leverage new schema definitions.
- Refined UI components to conditionally render descriptions and titles.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
MananTank
force-pushed
the
12-19-_tool-2800_use_openapiv3_types_in_insight_playground
branch
from
216f069 to
d7d9415
Compare
graphite-app
bot
deleted the
12-19-_tool-2800_use_openapiv3_types_in_insight_playground
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem solved
Short description of the bug fixed or feature added
PR-Codex overview
This PR introduces updates to the
dashboardapplication, primarily focusing on integratingopenapi-types, enhancing type safety, and refining the handling of blueprint specifications and parameters.Detailed summary
openapi-typestopackage.json.supportedChainIdsto use optional chaining.BlueprintCardto safely accessdescriptionandtitle.BlueprintParameterandBlueprintPathMetadatatypes to useOpenAPIV3types.fetchBlueprintSpecto accommodate new types.BlueprintPlaygroundUIfor better filtering and defaults.blueprint-playground.stories.tsxto reflect new parameter schemas.