docs: document IgnoreParseErrors parameter in OpenApiClientProvider.md#312
Merged
sergey-tihon merged 2 commits intorepo-assist/eng-ignore-parse-errors-2026-03-04c43dcd71f7a2a4from Mar 11, 2026
Conversation
Co-authored-by: sergey-tihon <1197905+sergey-tihon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add IgnoreParseErrors parameter to OpenApiClientProvider
docs: document IgnoreParseErrors parameter in OpenApiClientProvider.md
Mar 11, 2026
sergey-tihon
merged commit cb94668
into
repo-assist/eng-ignore-parse-errors-2026-03-04c43dcd71f7a2a4
17 checks passed
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the OpenApiClientProvider documentation to include the newly added IgnoreParseErrors static parameter, clarifying how to handle non-strict OpenAPI schemas while still generating a client.
Changes:
- Added
IgnoreParseErrorsto the parameters table with default and behavior details. - Added a dedicated section explaining when/why to use
IgnoreParseErrors, including an example and cautionary note.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
sergey-tihon
added a commit
that referenced
this pull request
Mar 11, 2026
#300) * Add IgnoreParseErrors static parameter to OpenApiClientProvider Allow users to continue generating the type provider even when Microsoft.OpenApi reports schema validation errors. This is useful for non-strictly-compliant schemas (e.g. NSwag-generated schemas with 'nullable: true' at the parameter level, as reported in issue #261). When IgnoreParseErrors=true the validation errors are printed to stderr as warnings instead of aborting the type provider. Default remains false (existing strict behaviour is unchanged). Also relax global.json SDK constraint from exact 10.0.103 to latestPatch rollForward from 10.0.100, so the build works with any available 10.0.x SDK patch. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: document IgnoreParseErrors parameter in OpenApiClientProvider.md (#312) * Initial plan * docs: add IgnoreParseErrors parameter to OpenApiClientProvider.md Co-authored-by: sergey-tihon <1197905+sergey-tihon@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: sergey-tihon <1197905+sergey-tihon@users.noreply.github.com> --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Sergey Tihon <sergey.tihon@gmail.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: sergey-tihon <1197905+sergey-tihon@users.noreply.github.com>
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.
The
IgnoreParseErrorsstatic parameter added toOpenApiClientProviderwas missing from the documentation.Changes
IgnoreParseErrorsrow describing its behaviour (emit stderr warnings instead of failing on parse errors, defaultfalse)nullable: trueat the parameter level), a usage example, and a caution about trusting the schema source🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.