OpenAPITools / OpenAPITools/openapi-generator
[BUG][SPRING][SPRING-CLOUD] Always generating using tags (even with useTags=false)
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
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
The spring-cloud library ignores both default and explicit setting of useTags config option to false.
Api classes are always generated according to tags, however it should be generated according to path by default just like spring-boot library do.
openapi-generator version
openapi-generator-maven-plugin 5.1.1
OpenAPI declaration file content or url
TBD
Generation Details
<configuration>
<inputSpec>${project.basedir}/src/main/resources/petstore.oas3.yaml</inputSpec>
<output>${project.build.directory}/generated-sources</output>
<generatorName>spring</generatorName>
<library>spring-cloud</library>
<configOptions>
<useTags>false</useTags>
<dateLibrary>java8</dateLibrary>
<openApiNullable>false</openApiNullable>
</configOptions>
</configuration>
Steps to reproduce
mvn clean generate-sources
Suggest a fix
useTags config should be respected for spring-cloud library.
For backward compatibility it may be by default false for spring-boot and true for spring-cloud.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java around line 503 and inspect how the spring-cloud library handles useTags. Reproduce with mvn clean generate-sources using the shown Maven configuration, then verify that useTags=false groups generated API classes by path rather than tags.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi, spring
- Domain
- api, backend, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100