fix(swagger): Resolve TypeScript errors for swagger modules#1137
Merged
Conversation
- Ensure missing dependencies are installed and locked in package-lock.json - Add explicit typing for dynamically imported SwaggerUI component
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds explicit typing to the dynamically imported SwaggerUI component to resolve TypeScript errors, and adjusts swagger-ui-react and @types/swagger-ui-react dependency specifiers in the lockfile to use caret ranges.
Changes:
- Import
SwaggerUIPropsand pass it as a generic todynamic<SwaggerUIProps>()inapi-docs.tsx. - Loosen pinned versions of
swagger-ui-reactand@types/swagger-ui-reactto caret ranges inpackage-lock.json. - Remove
libcmetadata fields from several optional native dependency entries inpackage-lock.json.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/pages/api-docs.tsx | Adds SwaggerUIProps type parameter to the dynamic import for type safety. |
| package-lock.json | Updates dependency version specifiers and removes libc fields from several optional native package entries. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
github-project-automation
Bot
moved this from Review / PR
to Done
in Vets Who Code Projects
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
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.
This pull request makes a small improvement to the way the
SwaggerUIcomponent is imported in thesrc/pages/api-docs.tsxfile. The change adds type safety by specifying theSwaggerUIPropstype when using Next.js'sdynamicimport. No other functionality or logic is affected.SwaggerUIcomponent by specifyingSwaggerUIPropsinsrc/pages/api-docs.tsx.- Ensure missing dependencies are installed and locked in package-lock.json