Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Issues
  • #11779
Closed
Open
Issue created Mar 03, 2022 by Administrator@rootContributor4 of 6 checklist items completed4/6 checklist items

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

Created by: 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}}
Assignee
Assign to
Time tracking