Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG][JAVA] AbstractOpenApiSchema package output and declaration missmatch #8583

Closed
6 tasks done
BenjaminKlatt opened this issue Jan 30, 2021 · 3 comments · Fixed by #8635
Closed
6 tasks done

[BUG][JAVA] AbstractOpenApiSchema package output and declaration missmatch #8583

BenjaminKlatt opened this issue Jan 30, 2021 · 3 comments · Fixed by #8635

Comments

@BenjaminKlatt
Copy link
Contributor

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 class AbstractOpenApiSchema is generated into the model package but declares a model package within the invoker package

Not sure if you prefer a pull request over a bug report. so starting with a bug report and a suggested fix below,

openapi-generator version

openapi-generator-maven-plugin 5.0.0

OpenAPI declaration file content or url

Does not depend on a specific openapi spec

Generation Details

Maven Plugin Configuration

<plugin>
	<groupId>org.openapitools</groupId>
	<artifactId>openapi-generator-maven-plugin</artifactId>
	<version>5.0.0</version>
	<executions>
		<execution>
			<goals>
				<goal>generate</goal>
			</goals>
			<configuration>
				<generatorName>java</generatorName>
				<inputSpec>${openapi.spec.path}</inputSpec>
				<apiPackage>com.example.api</apiPackage>
				<invokerPackage>com.example.invoker</invokerPackage>
				<modelPackage>com.example.model</modelPackage>
				<configOptions>
					<library>native</library>
					<dateLibrary>java8</dateLibrary>
				</configOptions>
			</configuration>
		</execution>
	</executions>
</plugin>
Steps to reproduce
  1. add plugin definition above to a maven project's pom
  2. reference any json based openapi spec as ${openapi.spec.path} property
  3. run mvn mvn clean generate-sources
  4. check AbstractOpenApiSchema.java file for valid package declaration (is generated into com.example.model but declares com.example.invoker.model as package
Related issues/PRs
Suggest a fix

Depending the result expected, the mustach template should use the model package declaration instead of {{invokerPackage}}.model


as this is also the case in the native petstore example: https://github.com/OpenAPITools/openapi-generator/blob/edf153eedef58bd04ffa02a56ecbe60a7165bf0f/samples/client/petstore/java/native/src/main/java/org/openapitools/client/model/AbstractOpenApiSchema.java

@wing328
Copy link
Member

wing328 commented Feb 1, 2021

@BenjaminKlatt thanks for reporting the issue. I wonder if you can file a PR with the suggested fix so that we can review the fix more easily?

@BenjaminKlatt
Copy link
Contributor Author

@BenjaminKlatt thanks for reporting the issue. I wonder if you can file a PR with the suggested fix so that we can review the fix more easily?

@wing328 yes, I will prepare one

BenjaminKlatt added a commit to BenjaminKlatt/openapi-generator that referenced this issue Feb 7, 2021
Fixed package declaration in AbstractOpenApiSchema.mustache template
@BenjaminKlatt
Copy link
Contributor Author

PR created: #8635

wing328 pushed a commit that referenced this issue Feb 8, 2021
Fixed package declaration in AbstractOpenApiSchema.mustache template
wing328 pushed a commit that referenced this issue Feb 15, 2021
* FIX #8583 [BUG][JAVA] AbstractOpenApiSchema package

Fixed package declaration in AbstractOpenApiSchema.mustache template

* New blog post added
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants