Skip to content

[BUG][JavaSpring] description value for @Operation annotation are not generated from OpenAPI definition #11779

@pichlau

Description

@pichlau

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

When I run the JavaSpring generator in my maven build execution from my OpenAPI definition yaml file, in the java code generated the #description value in the @operation annotation is absent.

@Operation(
    operationId = "xxxxxx",
    summary = "xxxxxxx",
    tags = { "xxxxx" },
)

it should be:

@Operation(
    operationId = "xxxxxx",
    summary = "xxxxxxx",
    description = "xxxxxxxx",
    tags = { "xxxxx" },
)
openapi-generator version

5.4.0

OpenAPI declaration file content or url

Any endpoint definition with a description will reveal the problem.

Generation Details

Generation running with maven plugin.

Steps to reproduce

Clear

Related issues/PRs

Clear

Suggest a fix

To correct the problem, simply replace in "modules/openapi-generator/src/main/resources/JavaSpring/api.mustache"

@Operation(
    operationId = "{{{operationId}}}",
    {{#summary}}
    summary = "{{{.}}}",
    {{/summary}}
    {{#vendorExtensions.x-tags.size}}

by

@Operation(
    operationId = "{{{operationId}}}",
    {{#summary}}
    summary = "{{{.}}}",
    {{/summary}}
    {{#description}}
    description= "{{{.}}}",
    {{/description}}
    {{#vendorExtensions.x-tags.size}}

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions