openapi-processor / openapi-processor-spring

an OpenAPI 3.0 & 3.1 interface & model java code generator for Spring Boot
https://docs.openapiprocessor.io
Apache License 2.0
40 stars 9 forks source link

description will not be used as javadoc when having custom type mapping #160

Closed Snap252 closed 1 year ago

Snap252 commented 1 year ago

having custom annotation will lead to breaking javadoc generation

having:

openapi-processor-mapping: v3

options:
  package-name: xxx
  bean-validation: true
  javadoc: true

map:
  types:
   - type: string:date-time => java.time.OffsetDateTime

and

title: DatumGesendet
x-stoplight:
  id: nzlj4zrmsiwoh
type: object
description: 'Zeitpunkt, zu dem die Nachricht vom Benutzer an das System übergeben wurde.'
properties:
  datumGesendet:
    type: string
    format: date-time
    description: 'Zeitpunkt, zu dem die Nachricht vom Benutzer an das System übergeben wurde.'
required:
  - datumGesendet

will generate:

    @NotNull
    @JsonProperty("datumGesendet")
    private OffsetDateTime datumGesendet;

without that string:date-time => java.time.OffsetDateTime:

    /** Zeitpunkt, zu dem die Nachricht vom Benutzer an das System übergeben wurde. */
    @NotNull
    @JsonProperty("datumGesendet")
    private OffsetDateTime datumGesendet;
hauner commented 1 year ago

oh, that's a "funny" bug. I wonder how that happened.

Thanks for reporting :-)