Schema properties description

[malakeel]

I need to produce a schema with properties that has description. I was not able to locate a configuration in maven-plugin that allows me to achieve this. For example, something like this will be very useful:

      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier for the product.

I tried to create a custom ModelReader to populate the description fields from some code parts like JavaDoc, but couldn't find any relevant example. The closest I was able to get is the AirLine example under TCK project. I think I can see where I can add the description. However, trying to produce a whole OpenApi object instead of just overriding some values in the existing one would be time consuming.

So my question is two folds:

• Is there an existing configuration value I can use to generate those "description" fields in the schema from JavaDoc ?
• If not, do we have any sort of Visitor Patter implementation, that allows me to navigate an already generated OpenApi Object, and enhance it with the description field without having to go through the whole OpenApi Object Creation ?

[MikeEdgar]

@malakeel I think what you're looking for is the OASFilter. You can implement that interface and update the model after all annotation/code scanning has completed. You can configure it in the Maven plugin with the <filter> element for the plugin's <configuration>.

Note that there isn't currently any way to get the JavaDoc text, however.

[malakeel]

@MikeEdgar
I can try to scan the JavaDoc with something like JavaParser, or eclipse JDT. But my problem is in integrating this with the existing build, without having to reimplement everything thing.
I think the configurations makes sense. I will take a look at it soon. Thank you. I will report back shortly.

[malakeel]

@MikeEdgar
By the way, is there another way to populate those description fields ?

[MikeEdgar]

You could also use the @Schema annotation, which has a description property. You would set that annotation directly on the fields/methods that correspond to the schema properties.