Improve OpenAPI parsing errors #3555
Merged
+48
−30
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
🦋 Changeset detectedLatest commit: 636d324 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR improves OpenAPI parsing error messages by making version-related errors more explicit and refactors some function names for clarity.
- Added explicit error handling for missing OpenAPI/Swagger versions with clearer error messages
- Refactored function and variable names for better clarity (cache vs weakmap, NoCache suffix)
- Updated test expectations to match the new error message format
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/openapi-parser/src/v3.ts | Added explicit version validation with improved error message and restructured validation logic |
| packages/openapi-parser/src/parse.test.ts | Updated test to expect the new, more specific error message |
| packages/gitbook/src/lib/openapi/resolveOpenAPIOperationBlock.ts | Renamed variables and functions for clarity (weakmap → cache, base → NoCache) |
| packages/gitbook/src/lib/openapi/fetch.ts | Refactored function names and added documentation, plus a console.log statement |
| .changeset/tough-beers-own.md | Added changeset for the OpenAPI parsing improvements |
conico974
reviewed
Aug 12, 2025
conico974
approved these changes
Aug 12, 2025
We make the error more explicit, saying that we didn't find any version.
gregberge
force-pushed
the
greg/rnd-7600-openapi-null-schema
branch
from
d67c455 to
636d324
Compare
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.
We make the error more explicit, saying that we didn't find any version.