Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Snap252 opened this issue May 2, 2023 · 1 comment
Closed
Labels
bug Something isn't working
Milestone

Comments

@Snap252
Copy link

Snap252 commented May 2, 2023

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
Copy link
Member

hauner commented May 3, 2023

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

Thanks for reporting :-)

hauner added a commit to openapi-processor/openapi-processor-base that referenced this issue May 7, 2023
hauner added a commit to openapi-processor/openapi-processor-base that referenced this issue May 7, 2023
hauner added a commit to openapi-processor/openapi-processor-base that referenced this issue May 7, 2023
@hauner hauner added the bug Something isn't working label May 7, 2023
@hauner hauner added this to the 2023.2 milestone May 7, 2023
@hauner hauner closed this as completed Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants