unchase / Unchase.Swashbuckle.AspNetCore.Extensions

:hammer: A library contains a bunch of extensions (filters) for Swashbuckle.AspNetCore.
https://www.nuget.org/packages/Unchase.Swashbuckle.AspNetCore.Extensions
Apache License 2.0
115 stars 16 forks source link

IncludeXmlCommentsFromInheritDocs always produces value from <example> tag as string. #34

Open patadata opened 6 months ago

patadata commented 6 months ago

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"
},
.
.

Error

.
.
  "range": {
    "start": {
      "line": 4475,
      "character": 23
    },
    "end": {
      "line": 4475,
      "character": 27
    }
  },
  "severity": 1,
  "code": "oas3-valid-schema-example",
  "source": "spectral",
  "message": "\"example\" property type must be integer,null"
},
.
.

Finding in code

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.