Describe the bug
I have used a simple schema with two properties. Both properties has an normal description and a markdown description.
Mybar property has a reference to an definition.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"foo": {
"type": "string",
"title": "foo title",
"description": "foo desc",
"markdownDescription": "foo md desc **bold** \n * line \n* another \n\n"
},
"bar": {
"$ref": "#/$defs/veggie",
"title": "bar title",
"description": "bar desc",
"markdownDescription": "bar md desc **bold** \n * line \n* another \n\n"
}
},
"$defs": {
"veggie": {
"type": "string",
"enum": [
"potato",
"carrot"
]
}
}
}
When I am using this schema in VS Code and looking at the documentation of both properties
foo is getting the markdown description (correct)
bar is displaying its normal description despite having a markdown description (incorrect)
Expected Behavior
I expect that any given markdown description will always beat the normal description and will be always rendered.
Current Behavior
The markdown description of an property with an ref element was not rendered, but instead the normal description.
Steps to Reproduce
- Use the schema given above in VS Code in an file
- Preview the description of
foo -> markdown -> correct
- Preview the description of
bar -> no markdown -> incorrect
Environment
Describe the bug
I have used a simple schema with two properties. Both properties has an normal description and a markdown description.
My
barproperty has a reference to an definition.{ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "foo": { "type": "string", "title": "foo title", "description": "foo desc", "markdownDescription": "foo md desc **bold** \n * line \n* another \n\n" }, "bar": { "$ref": "#/$defs/veggie", "title": "bar title", "description": "bar desc", "markdownDescription": "bar md desc **bold** \n * line \n* another \n\n" } }, "$defs": { "veggie": { "type": "string", "enum": [ "potato", "carrot" ] } } }When I am using this schema in VS Code and looking at the documentation of both properties
foois getting the markdown description (correct)baris displaying its normal description despite having a markdown description (incorrect)Expected Behavior
I expect that any given markdown description will always beat the normal description and will be always rendered.
Current Behavior
The markdown description of an property with an ref element was not rendered, but instead the normal description.
Steps to Reproduce
foo-> markdown -> correctbar-> no markdown -> incorrectEnvironment