[0.12.3] Fix crash in logging when property named "$ref" #410
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.
Fix: Handle
$ref
as JSON object in OpenAPI specificationsProblem
The
ObjectPath.FromObject()
method assumes that$ref
fields in OpenAPI specifications are always strings (references like"#/definitions/FieldType"
). However, in some OpenAPI specs,$ref
can be a JSON object that defines a schema, causing anInvalidCastException
when the code attempts to cast aJObject
to a string.This showed up in the CI run for the following azure-rest-api-specs error below:
https://github.com/Azure/azure-rest-api-specs/actions/runs/18208997652
Reproduction Case
When processing OpenAPI specifications containing schema definitions like:
The following error occurs:
Root Cause
The original code in
FromObject()
method attempted to call@ref.Value<string>()
without checking if@ref
is actually a string. When$ref
is a JSON object (schema definition), this causes a cast exception.Solution
@ref.Type == JTokenType.String
before attempting string conversionTesting
npm run dn.test
and verified its pass$ref
values$ref
fields