When validating the generated OpenApi specification using the Spectral open-source API style guide enforcer and linter (https://stoplight.io/open-source/spectral) we get a lot of errors regarding examples that has wrong types.
The problem for us is that all numbers as in int, double, decimal, float etc. are all generated as strings so the validator gives us errors saying that the example is of wrong type.
Generated JSON
.
.
"breakValueRightShaft5": {
"type": "number",
"description": "Break value for right shaft 5",
"format": "integer",
"nullable": true,
"example": "2"
},
.
.
I have found this code where this is handled inside of XmlCommentsExtensions.cs :
var exampleNode = targetXmlNode.SelectSingleNode(ExampleTag);
if (exampleNode != null)
{
schema.Example = new OpenApiString(XmlCommentsTextHelper.Humanize(exampleNode.InnerXml));
}
As we can see above, it will always render an OpenApiString, no matter what type it actually shouold be.
When validating the generated OpenApi specification using the Spectral open-source API style guide enforcer and linter (https://stoplight.io/open-source/spectral) we get a lot of errors regarding examples that has wrong types.
The problem for us is that all numbers as in int, double, decimal, float etc. are all generated as strings so the validator gives us errors saying that the example is of wrong type.
Generated JSON
Error
Finding in code
I have found this code where this is handled inside of XmlCommentsExtensions.cs :
As we can see above, it will always render an OpenApiString, no matter what type it actually shouold be.