Improve error handling when spec isn't valid #1200
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
Check for validation results that will result in an error and reject with that error. Also, add additional safety around the `conversionResult` handling to avoid generic errors on failure.
sserrata
approved these changes
Jul 14, 2025
|
Thanks @Dianoga, the proposed change works as expected. |
|
Visit the preview URL for this PR (updated for commit d473ea5): https://docusaurus-openapi-36b86--pr1200-pj7cypa3.web.app (expires Wed, 13 Aug 2025 19:30:38 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
Visual Diff SummaryTotal: 77, Matches: 77, Diffs: 0, Skipped: 0
|
dsuket
pushed a commit
to dsuket/docusaurus-openapi-docs
that referenced
this pull request
Oct 13, 2025
Check for validation results that will result in an error and reject with that error. Also, add additional safety around the `conversionResult` handling to avoid generic errors on failure.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Check for validation results that will result in an error and reject with that error.
Also, add additional safety around the
conversionResulthandling to avoid generic errors on failure.Motivation and Context
When a spec is provided that was missing required fields (
title,version) in theinfosection, the build process would fail with a genericTypeErrordue toconversionResultnot existing.How Has This Been Tested?
Only locally in the compiled
node_modulesenvironment.Types of changes
Checklist