micronaut-openapi
micronaut-openapi copied to clipboard
param descriptions of data model / responses are not pulled from javadocs (kotlin)
consider:
/**
* @param more This property identifies if there is more content available based on the search criteria. The absence of this property means the value is false.
* @param next This property identifies the server provided value of the next record or set of records in the paginated data set. This property MAY be populated if the more property is set to true.
* @param objects This property contains one or more STIX Objects. Objects in this list MUST be a STIX Object (e.g., SDO, SCO, SRO, Language Content object, or a Marking Definition object).
*/
@Schema(name = "envelop", description = "The envelope is a simple wrapper for STIX 2 content. When returning STIX 2 content in a TAXII response the HTTP root object payload \u200BMUST\u200B be an \u200Benvelope\u200B. This specification does not define any other form of content wrapper for objects outside of STIX content.")
data class Envelop(
@get:Schema(description = "This property identifies if there is more content available based on the search criteria. The absence of this property means the value is false.")
val more: Boolean = false,
val next: String? = null,
val objects: List<Map<String, Any>?> = listOf() // Is this supposed to be a null or empty list?
)
The @get:Schema(description = "This property identifies if there is more content available based on the search criteria. The absence of this property means the value is false.") had to be added for the description to be provided. It was not "auto" pulled from the class' javadoc
Using 1.3.4
Is this the same as #265?
@alvarosanchez I think it may be? Definitely all in a similar problem set.
@StephenOTT I got it to work with the following https://github.com/micronaut-projects/micronaut-openapi/issues/265#issuecomment-777007552