Support setting description on object properties

[dennisameling]

As part of the OpenAPI 3 spec, it's supported to set a description on object properties:

  "components" : {
    "schemas" : {
      "DummyObject" : {
        "type" : "object",
        "additionalProperties" : false,
        "properties" : {
          "dummy_property" : {
            "type" : "string",
            "format" : "date-time",
            "example" : "2022-12-30T12:00:00Z",
            "description": "Fancy description here" <-- This one
          },
          "dummy_property_two" : {
            "type" : "string",
            "format" : "date-time",
            "example" : "2022-12-30T12:15:00Z"
          },
        },
        "required" : [ "dummy_property"]
      }
  }

However, this library doesn't seem to support that. Please let me know if I missed something here though. I found things like @OpenApiName, @OpenApiExample and @OpenApiPropertyType, but couldn't find anything to set a description. I also tried with the @Custom annotation which I came across in your tests, but it doesn't seem to have any effect on the generated spec.

Thanks in advance! 😊

[dzikoysk]

I've added @OpenApiDescription annotation + @Custom should work on classes as well now :)

[dennisameling]

Wow, that was fast!! Thank you so much! 🚀

[dzikoysk]

Sure, let me know if you'll experience more issues :)