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
  • Merge requests
  • !13434

[Java][Spring] Ensure class level tags match the operation level tags to stop each operation to appear twice - issue 11570

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged GregDThomas requested to merge github/fork/GregDThomas/fix-double-operation into master Sep 15, 2022
  • Overview 20
  • Commits 1
  • Pipelines 0
  • Changes 74

This fixes https://github.com/OpenAPITools/openapi-generator/issues/11570 by removing the unnecessary tags at the class level. A tag appears in the spec at an operation level - https://swagger.io/docs/specification/grouping-operations-with-tags/

So applying these tags at both controller and operation level is unnecessary. And if you do, the operation appears twice when rendered by a swagger generator, once grouped under the tag for the controller, and once under the tag for the method.

Update: This fixes https://github.com/OpenAPITools/openapi-generator/issues/11570 by ensuring the tag at the class level has the same name as the tag in the operation (specifically, the first tag of the first operation). Previously the class level tag was similar to the operation level tag, but subtly different (e.g. Store vs. store) causing the operation to appear twice in the swagger-ui, once under each tag. Now it is consistent for both controller and operation - store - the operation appears just the once.

@cachescrubber @welshm @MelleD @borsch @Zomzog

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/GregDThomas/fix-double-operation