Add logging for OpenAPI schema default value type mismatches #63027
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
The current
ApplyDefaultValue
method in OpenAPI schema generation fails when there are type mismatches between default values and their target types, particularly in F# scenarios. For example:This causes
InvalidCastException
duringJsonSerializer.SerializeToNode()
calls, preventing OpenAPI schema generation from completing successfully.Solution
This PR implements a logging-based approach that:
ILogger
Implementation
The change adds logging infrastructure and modifies the
ApplyDefaultValue
method inJsonNodeSchemaExtensions.cs
:Testing
Added comprehensive tests that verify:
[DefaultValue(10)] ulong id
)Compatibility
[<DefaultParameterValue>]
type mismatches with proper loggingFixes scenarios where OpenAPI generation would previously fail with
InvalidCastException
, now producing valid schemas while alerting developers to type mismatches through logging.💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.