OpenAPITools / OpenAPITools/openapi-generator
[BUG][JAVA] swaggerDocketConfig not working as expected
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?
Description
In the current version I have seen following behaviour. If I´m setting <swaggerDocketConfig>false</swaggerDocketConfig> to false, the class OpenAPIDocumentationConfig.java with Docket (springfox) is still generated.
For me it looks like there are some impacts to other properties.
Expected behaviour
Don´t generate OpenAPIDocumentationConfig.java if property is set to false.
config-snipped from pom.xml:
<configuration>
<inputSpec>src/main/resources/schema/my.yaml</inputSpec>
<generatorName>spring</generatorName>
<library>spring-boot</library>
<configOptions>
<delegatePattern>true</delegatePattern>
<swaggerDocketConfig>false</swaggerDocketConfig>
</configOptions>
</configuration>
openapi-generator version
5.2.1
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 by locating OpenAPIDocumentationConfig.java and the code that reads the swaggerDocketConfig option for the spring generator. Reproduce the issue with the pom.xml configuration shown, using swaggerDocketConfig=false. Done means OpenAPIDocumentationConfig.java is not generated while the other configuration options continue to work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring, spring-boot
- Domain
- backend, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 32/100