[Java Spring OAS3] Minor fixes and general improvements - #11229

Merged
wing328 merged 17 commits into
OpenAPITools:masterfrom
cachescrubber:feature/relative_imports_pr
Jan 17, 2022
Merged

[Java Spring OAS3] Minor fixes and general improvements#11229
wing328 merged 17 commits into
OpenAPITools:masterfrom
cachescrubber:feature/relative_imports_pr

Conversation

@cachescrubber

@cachescrubbercachescrubber commented Jan 4, 2022

Copy link
Copy Markdown
Contributor

A follow up to #11181. The OAS3 @Operation (Api) and @Schema (Model) annotations have been refined. Also, I did a major cleanup of the mustache templates and the generated source files.

PR checklist

  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [ x] 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 (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@cachescrubber
* Use Relative Imports for org.springframework.core.io.Resource
63413b6
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore
@cachescrubber
Add spring-stubs-oas3.yaml test config
6649749
@cachescrubber
Generate all samples
a28c16f
@cachescrubber

cachescrubber commented Jan 4, 2022

Copy link
Copy Markdown
ContributorAuthor

@wing328 Please have a look.

@wing328

wing328 commented Jan 12, 2022

Copy link
Copy Markdown
Member

@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.

@welshm can you please take a look at this PR as well?

@welshm

welshm commented Jan 12, 2022

Copy link
Copy Markdown
Contributor

@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.

@welshm can you please take a look at this PR as well?

Will take a look this evening

@cachescrubber

cachescrubber commented Jan 12, 2022

Copy link
Copy Markdown
ContributorAuthor

@wing328 thx for the review. I added a short non JavaDoc comment as you suggested.

@welshm sorry - forgot to notify you of the PR.

welshm
welshm reviewed Jan 13, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java Outdated
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java Outdated
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{#async}}
import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
{{/async}}
import javax.annotation.Generated;

@welshmwelshmJan 13, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self; added import because generated annotation is no longer fully qualified

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
{{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
{{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
{{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},

@welshmwelshmJan 13, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: ApiIgnore added to imports

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache

// Override this method
{{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
{{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {

@welshmwelshmJan 13, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: Pageable added to imports

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache
@Valid{{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
@Valid{{/isPrimitiveType}}{{/isContainer}}
{{>beanValidationCore}}
{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}} No newline at end of file

@welshmwelshmJan 13, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra spaces after @Valid - doesn't seem like a big deal though

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/enumOuterClass.mustache
*/
{{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
{{>additionalEnumTypeAnnotations}}
{{>generatedAnnotation}}

@welshmwelshmJan 13, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New annotation added here

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
@DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
{{/isDateTime}}
{{#openApiNullable}}
private {{>nullableDataType}} {{name}}{{#isNullable}} = JsonNullable.undefined(){{/isNullable}}{{^isNullable}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isNullable}};

@welshmwelshmJan 13, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, are there tests for a nullable field?

I had to fix this locally and haven't upstreamed the changes yet but we're also using a generator one version behind

@wing328wing328Jan 16, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but those tests in the 3.0 spec: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1813

Spring samples (most if not all) are using 2.0 spec at the moment. We'll need to update these config to use the 3.0 spec instead.

@welshmwelshmJan 16, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look to update that in the coming weeks

@cachescrubbercachescrubberJan 16, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least I introduced test configs for oas3 output format... We could update some of them to use 3.0 as input as well. But this could lead to even more test cases ...

oas2 -> oas2 -> ok
oas2 -> oas3 -> ok
oas3 -> oas2 -> do we even need this?
oas3 -> oas3 -> partially ok. This should be the fokus.

@welshm

welshm commented Jan 13, 2022

Copy link
Copy Markdown
Contributor

Overall this looks good to me - just the one comment about useSpringFox but otherwise looks like good cleanup

@wing328

wing328 commented Jan 13, 2022

Copy link
Copy Markdown
Member

@cachescrubber pls let me know if you need help fixing the merge conflicts as I've reordered the tests (spring, apache camel) a bit in pom.xml.

@cachescrubber

cachescrubber commented Jan 13, 2022

Copy link
Copy Markdown
ContributorAuthor

@wing328 I reverted 1915f8b - please check the merge result.

@cachescrubber
Evaluate additional property useSpringfox as Boolean
2a9f955
@cachescrubber
Generate all samples after merge (java-camel)
58065de
@cachescrubber
Fix typo
a46f702
@cachescrubber
Move java-camel test deom samples.circleci.spring to samples.circleci…
11c9c74
… profile.
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
b43e79f
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
e5289bb
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/FileSchemaTestClass.java
@cachescrubber
re-generate all samples after merge
1e801fe
@cachescrubber
Generate samples and docs after merge
ac1496c
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
235a59c
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/File.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/File.java
@cachescrubber
Generate samples after merge conflicts resolved
ee7a1a6
@cachescrubber

cachescrubber commented Jan 17, 2022

Copy link
Copy Markdown
ContributorAuthor

@wing328 I merge master and resolved conflicts twice. CI seems a bit spurious, could you please check?

@wing328

wing328 commented Jan 17, 2022

Copy link
Copy Markdown
Member

For the bitrise CI failure, please ignore it.

@wing328
wing328 merged commit 0f6b620 into OpenAPITools:masterJan 17, 2022
@cachescrubber
cachescrubber deleted the feature/relative_imports_pr branch January 17, 2022 09:12
@cachescrubbercachescrubber mentioned this pull request Jan 17, 2022
Merged
1 task
@wing328wing328 added this to the 5.4.0 milestone Jan 31, 2022
@mikkomaunumikkomaunu mentioned this pull request Apr 10, 2022
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
+1 more reviewer
@welshmwelshmwelshm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Enhancement: GeneralIssue: BugServer: JavaServer: Spring

Projects

None yet

Milestone

5.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@cachescrubber@wing328@welshm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[Java Spring OAS3] Minor fixes and general improvements - #11229
Merged
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Jan 17, 2022
Merged
[Java Spring OAS3] Minor fixes and general improvements#11229
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

Contributor
A follow up to #11181. The OAS3 @Operation (Api) and @Schema (Model) annotations have been refined. Also, I did a major cleanup of the mustache templates and the generated source files.
PR checklist
  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [ x] 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 (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
* Use Relative Imports for org.springframework.core.io.Resource
63413b6
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore
@cachescrubber
Add spring-stubs-oas3.yaml test config
6649749
@cachescrubber
Generate all samples
a28c16f
@cachescrubber
cachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Please have a look.
@wing328
wing328
commented
Jan 12, 2022

Copy link


Copy Markdown

Member
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
@welshm
welshm
commented
Jan 12, 2022

Copy link


Copy Markdown

Contributor
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
Will take a look this evening
@cachescrubber
cachescrubber
commented
Jan 12, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 thx for the review. I added a short non JavaDoc comment as you suggested.
@welshm sorry - forgot to notify you of the PR.
welshm
welshm
reviewed
Jan 13, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{#async}}
import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
{{/async}}
import javax.annotation.Generated;
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self; added import because generated annotation is no longer fully qualified
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
 {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
 {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: ApiIgnore added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache

 // Override this method
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: Pageable added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache
 @Valid{{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
 @Valid{{/isPrimitiveType}}{{/isContainer}}
{{>beanValidationCore}}
{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}} No newline at end of file 
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra spaces after @Valid  - doesn't seem like a big deal though
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/enumOuterClass.mustache
 */
{{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
{{>additionalEnumTypeAnnotations}}
{{>generatedAnnotation}}
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New annotation added here
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
 @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
 {{/isDateTime}}
 {{#openApiNullable}}
 private {{>nullableDataType}} {{name}}{{#isNullable}} = JsonNullable.undefined(){{/isNullable}}{{^isNullable}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isNullable}};
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, are there tests for a nullable field?
I had to fix this locally and haven't upstreamed the changes yet but we're also using a generator one version behind
@wing328wing328Jan 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but those tests in the 3.0 spec: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1813
Spring samples (most if not all) are using 2.0 spec at the moment. We'll need to update these config to use the 3.0 spec instead.
@welshmwelshmJan 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look to update that in the coming weeks
@cachescrubbercachescrubberJan 16, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least I introduced test configs for oas3 output format... We could update some of them to use 3.0 as input as well. But this could lead to even more test cases ...
oas2 -> oas2 -> ok

oas2 -> oas3 -> ok

oas3 -> oas2 -> do we even need this?

oas3 -> oas3 -> partially ok. This should be the fokus.
@welshm
welshm
commented
Jan 13, 2022

Copy link


Copy Markdown

Contributor
Overall this looks good to me - just the one comment about useSpringFox but otherwise looks like good cleanup
@wing328
wing328
commented
Jan 13, 2022

Copy link


Copy Markdown

Member
@cachescrubber pls let me know if you need help fixing the merge conflicts as I've reordered the tests (spring, apache camel) a bit in pom.xml.
@cachescrubber
cachescrubber
commented
Jan 13, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I reverted 1915f8b - please check the merge result.
@cachescrubber
Evaluate additional property useSpringfox as Boolean
2a9f955
@cachescrubber
Generate all samples after merge (java-camel)
58065de
@cachescrubber
Fix typo
a46f702
@cachescrubber
Move java-camel test deom samples.circleci.spring to samples.circleci…
11c9c74
… profile.
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
b43e79f
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
e5289bb
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/FileSchemaTestClass.java
@cachescrubber
re-generate all samples after merge
1e801fe
@cachescrubber
Generate samples and docs after merge
ac1496c
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
235a59c
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/File.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/File.java
@cachescrubber
Generate samples after merge conflicts resolved
ee7a1a6
@cachescrubber
cachescrubber
commented
Jan 17, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I merge master and resolved conflicts twice. CI seems a bit spurious, could you please check?
@wing328
wing328
commented
Jan 17, 2022

Copy link


Copy Markdown

Member
For the bitrise CI failure, please ignore it.
@wing328
wing328
merged commit 0f6b620
into
OpenAPITools:masterJan 17, 2022
@cachescrubber
cachescrubber
deleted the

feature/relative_imports_pr

branch
January 17, 2022 09:12
@cachescrubbercachescrubber
mentioned this pull request
Jan 17, 2022
 Merged

1 task
@wing328wing328
added this to the 5.4.0 milestone
Jan 31, 2022
@mikkomaunumikkomaunu
mentioned this pull request
Apr 10, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@welshmwelshmwelshm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Enhancement: GeneralIssue: BugServer: JavaServer: Spring

Projects


None yet


Milestone

5.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@cachescrubber@wing328@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[Java Spring OAS3] Minor fixes and general improvements - #11229
Merged
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Jan 17, 2022
Merged
[Java Spring OAS3] Minor fixes and general improvements#11229
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

Contributor
A follow up to #11181. The OAS3 @Operation (Api) and @Schema (Model) annotations have been refined. Also, I did a major cleanup of the mustache templates and the generated source files.
PR checklist
  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [ x] 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 (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
* Use Relative Imports for org.springframework.core.io.Resource
63413b6
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore
@cachescrubber
Add spring-stubs-oas3.yaml test config
6649749
@cachescrubber
Generate all samples
a28c16f
@cachescrubber
cachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Please have a look.
@wing328
wing328
commented
Jan 12, 2022

Copy link


Copy Markdown

Member
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
@welshm
welshm
commented
Jan 12, 2022

Copy link


Copy Markdown

Contributor
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
Will take a look this evening
@cachescrubber
cachescrubber
commented
Jan 12, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 thx for the review. I added a short non JavaDoc comment as you suggested.
@welshm sorry - forgot to notify you of the PR.
welshm
welshm
reviewed
Jan 13, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{#async}}
import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
{{/async}}
import javax.annotation.Generated;
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self; added import because generated annotation is no longer fully qualified
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
 {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
 {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: ApiIgnore added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache

 // Override this method
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: Pageable added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache
 @Valid{{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
 @Valid{{/isPrimitiveType}}{{/isContainer}}
{{>beanValidationCore}}
{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}} No newline at end of file 
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra spaces after @Valid  - doesn't seem like a big deal though
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/enumOuterClass.mustache
 */
{{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
{{>additionalEnumTypeAnnotations}}
{{>generatedAnnotation}}
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New annotation added here
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
 @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
 {{/isDateTime}}
 {{#openApiNullable}}
 private {{>nullableDataType}} {{name}}{{#isNullable}} = JsonNullable.undefined(){{/isNullable}}{{^isNullable}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isNullable}};
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, are there tests for a nullable field?
I had to fix this locally and haven't upstreamed the changes yet but we're also using a generator one version behind
@wing328wing328Jan 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but those tests in the 3.0 spec: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1813
Spring samples (most if not all) are using 2.0 spec at the moment. We'll need to update these config to use the 3.0 spec instead.
@welshmwelshmJan 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look to update that in the coming weeks
@cachescrubbercachescrubberJan 16, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least I introduced test configs for oas3 output format... We could update some of them to use 3.0 as input as well. But this could lead to even more test cases ...
oas2 -> oas2 -> ok

oas2 -> oas3 -> ok

oas3 -> oas2 -> do we even need this?

oas3 -> oas3 -> partially ok. This should be the fokus.
@welshm
welshm
commented
Jan 13, 2022

Copy link


Copy Markdown

Contributor
Overall this looks good to me - just the one comment about useSpringFox but otherwise looks like good cleanup
@wing328
wing328
commented
Jan 13, 2022

Copy link


Copy Markdown

Member
@cachescrubber pls let me know if you need help fixing the merge conflicts as I've reordered the tests (spring, apache camel) a bit in pom.xml.
@cachescrubber
cachescrubber
commented
Jan 13, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I reverted 1915f8b - please check the merge result.
@cachescrubber
Evaluate additional property useSpringfox as Boolean
2a9f955
@cachescrubber
Generate all samples after merge (java-camel)
58065de
@cachescrubber
Fix typo
a46f702
@cachescrubber
Move java-camel test deom samples.circleci.spring to samples.circleci…
11c9c74
… profile.
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
b43e79f
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
e5289bb
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/FileSchemaTestClass.java
@cachescrubber
re-generate all samples after merge
1e801fe
@cachescrubber
Generate samples and docs after merge
ac1496c
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
235a59c
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/File.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/File.java
@cachescrubber
Generate samples after merge conflicts resolved
ee7a1a6
@cachescrubber
cachescrubber
commented
Jan 17, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I merge master and resolved conflicts twice. CI seems a bit spurious, could you please check?
@wing328
wing328
commented
Jan 17, 2022

Copy link


Copy Markdown

Member
For the bitrise CI failure, please ignore it.
@wing328
wing328
merged commit 0f6b620
into
OpenAPITools:masterJan 17, 2022
@cachescrubber
cachescrubber
deleted the

feature/relative_imports_pr

branch
January 17, 2022 09:12
@cachescrubbercachescrubber
mentioned this pull request
Jan 17, 2022
 Merged

1 task
@wing328wing328
added this to the 5.4.0 milestone
Jan 31, 2022
@mikkomaunumikkomaunu
mentioned this pull request
Apr 10, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@welshmwelshmwelshm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Enhancement: GeneralIssue: BugServer: JavaServer: Spring

Projects


None yet


Milestone

5.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@cachescrubber@wing328@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[Java Spring OAS3] Minor fixes and general improvements - #11229
Merged
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Jan 17, 2022
Merged
[Java Spring OAS3] Minor fixes and general improvements#11229
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

Contributor
A follow up to #11181. The OAS3 @Operation (Api) and @Schema (Model) annotations have been refined. Also, I did a major cleanup of the mustache templates and the generated source files.
PR checklist
  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [ x] 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 (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
* Use Relative Imports for org.springframework.core.io.Resource
63413b6
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore
@cachescrubber
Add spring-stubs-oas3.yaml test config
6649749
@cachescrubber
Generate all samples
a28c16f
@cachescrubber
cachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Please have a look.
@wing328
wing328
commented
Jan 12, 2022

Copy link


Copy Markdown

Member
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
@welshm
welshm
commented
Jan 12, 2022

Copy link


Copy Markdown

Contributor
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
Will take a look this evening
@cachescrubber
cachescrubber
commented
Jan 12, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 thx for the review. I added a short non JavaDoc comment as you suggested.
@welshm sorry - forgot to notify you of the PR.
welshm
welshm
reviewed
Jan 13, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{#async}}
import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
{{/async}}
import javax.annotation.Generated;
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self; added import because generated annotation is no longer fully qualified
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
 {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
 {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: ApiIgnore added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache

 // Override this method
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: Pageable added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache
 @Valid{{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
 @Valid{{/isPrimitiveType}}{{/isContainer}}
{{>beanValidationCore}}
{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}} No newline at end of file 
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra spaces after @Valid  - doesn't seem like a big deal though
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/enumOuterClass.mustache
 */
{{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
{{>additionalEnumTypeAnnotations}}
{{>generatedAnnotation}}
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New annotation added here
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
 @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
 {{/isDateTime}}
 {{#openApiNullable}}
 private {{>nullableDataType}} {{name}}{{#isNullable}} = JsonNullable.undefined(){{/isNullable}}{{^isNullable}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isNullable}};
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, are there tests for a nullable field?
I had to fix this locally and haven't upstreamed the changes yet but we're also using a generator one version behind
@wing328wing328Jan 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but those tests in the 3.0 spec: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1813
Spring samples (most if not all) are using 2.0 spec at the moment. We'll need to update these config to use the 3.0 spec instead.
@welshmwelshmJan 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look to update that in the coming weeks
@cachescrubbercachescrubberJan 16, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least I introduced test configs for oas3 output format... We could update some of them to use 3.0 as input as well. But this could lead to even more test cases ...
oas2 -> oas2 -> ok

oas2 -> oas3 -> ok

oas3 -> oas2 -> do we even need this?

oas3 -> oas3 -> partially ok. This should be the fokus.
@welshm
welshm
commented
Jan 13, 2022

Copy link


Copy Markdown

Contributor
Overall this looks good to me - just the one comment about useSpringFox but otherwise looks like good cleanup
@wing328
wing328
commented
Jan 13, 2022

Copy link


Copy Markdown

Member
@cachescrubber pls let me know if you need help fixing the merge conflicts as I've reordered the tests (spring, apache camel) a bit in pom.xml.
@cachescrubber
cachescrubber
commented
Jan 13, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I reverted 1915f8b - please check the merge result.
@cachescrubber
Evaluate additional property useSpringfox as Boolean
2a9f955
@cachescrubber
Generate all samples after merge (java-camel)
58065de
@cachescrubber
Fix typo
a46f702
@cachescrubber
Move java-camel test deom samples.circleci.spring to samples.circleci…
11c9c74
… profile.
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
b43e79f
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
e5289bb
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/FileSchemaTestClass.java
@cachescrubber
re-generate all samples after merge
1e801fe
@cachescrubber
Generate samples and docs after merge
ac1496c
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
235a59c
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/File.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/File.java
@cachescrubber
Generate samples after merge conflicts resolved
ee7a1a6
@cachescrubber
cachescrubber
commented
Jan 17, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I merge master and resolved conflicts twice. CI seems a bit spurious, could you please check?
@wing328
wing328
commented
Jan 17, 2022

Copy link


Copy Markdown

Member
For the bitrise CI failure, please ignore it.
@wing328
wing328
merged commit 0f6b620
into
OpenAPITools:masterJan 17, 2022
@cachescrubber
cachescrubber
deleted the

feature/relative_imports_pr

branch
January 17, 2022 09:12
@cachescrubbercachescrubber
mentioned this pull request
Jan 17, 2022
 Merged

1 task
@wing328wing328
added this to the 5.4.0 milestone
Jan 31, 2022
@mikkomaunumikkomaunu
mentioned this pull request
Apr 10, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@welshmwelshmwelshm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Enhancement: GeneralIssue: BugServer: JavaServer: Spring

Projects


None yet


Milestone

5.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@cachescrubber@wing328@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[Java Spring OAS3] Minor fixes and general improvements - #11229
Merged
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Jan 17, 2022
Merged
[Java Spring OAS3] Minor fixes and general improvements#11229
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

Contributor
A follow up to #11181. The OAS3 @Operation (Api) and @Schema (Model) annotations have been refined. Also, I did a major cleanup of the mustache templates and the generated source files.
PR checklist
  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [ x] 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 (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
* Use Relative Imports for org.springframework.core.io.Resource
63413b6
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore
@cachescrubber
Add spring-stubs-oas3.yaml test config
6649749
@cachescrubber
Generate all samples
a28c16f
@cachescrubber
cachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Please have a look.
@wing328
wing328
commented
Jan 12, 2022

Copy link


Copy Markdown

Member
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
@welshm
welshm
commented
Jan 12, 2022

Copy link


Copy Markdown

Contributor
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
Will take a look this evening
@cachescrubber
cachescrubber
commented
Jan 12, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 thx for the review. I added a short non JavaDoc comment as you suggested.
@welshm sorry - forgot to notify you of the PR.
welshm
welshm
reviewed
Jan 13, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{#async}}
import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
{{/async}}
import javax.annotation.Generated;
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self; added import because generated annotation is no longer fully qualified
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
 {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
 {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: ApiIgnore added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache

 // Override this method
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: Pageable added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache
 @Valid{{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
 @Valid{{/isPrimitiveType}}{{/isContainer}}
{{>beanValidationCore}}
{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}} No newline at end of file 
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra spaces after @Valid  - doesn't seem like a big deal though
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/enumOuterClass.mustache
 */
{{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
{{>additionalEnumTypeAnnotations}}
{{>generatedAnnotation}}
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New annotation added here
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
 @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
 {{/isDateTime}}
 {{#openApiNullable}}
 private {{>nullableDataType}} {{name}}{{#isNullable}} = JsonNullable.undefined(){{/isNullable}}{{^isNullable}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isNullable}};
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, are there tests for a nullable field?
I had to fix this locally and haven't upstreamed the changes yet but we're also using a generator one version behind
@wing328wing328Jan 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but those tests in the 3.0 spec: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1813
Spring samples (most if not all) are using 2.0 spec at the moment. We'll need to update these config to use the 3.0 spec instead.
@welshmwelshmJan 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look to update that in the coming weeks
@cachescrubbercachescrubberJan 16, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least I introduced test configs for oas3 output format... We could update some of them to use 3.0 as input as well. But this could lead to even more test cases ...
oas2 -> oas2 -> ok

oas2 -> oas3 -> ok

oas3 -> oas2 -> do we even need this?

oas3 -> oas3 -> partially ok. This should be the fokus.
@welshm
welshm
commented
Jan 13, 2022

Copy link


Copy Markdown

Contributor
Overall this looks good to me - just the one comment about useSpringFox but otherwise looks like good cleanup
@wing328
wing328
commented
Jan 13, 2022

Copy link


Copy Markdown

Member
@cachescrubber pls let me know if you need help fixing the merge conflicts as I've reordered the tests (spring, apache camel) a bit in pom.xml.
@cachescrubber
cachescrubber
commented
Jan 13, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I reverted 1915f8b - please check the merge result.
@cachescrubber
Evaluate additional property useSpringfox as Boolean
2a9f955
@cachescrubber
Generate all samples after merge (java-camel)
58065de
@cachescrubber
Fix typo
a46f702
@cachescrubber
Move java-camel test deom samples.circleci.spring to samples.circleci…
11c9c74
… profile.
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
b43e79f
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
e5289bb
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/FileSchemaTestClass.java
@cachescrubber
re-generate all samples after merge
1e801fe
@cachescrubber
Generate samples and docs after merge
ac1496c
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
235a59c
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/File.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/File.java
@cachescrubber
Generate samples after merge conflicts resolved
ee7a1a6
@cachescrubber
cachescrubber
commented
Jan 17, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I merge master and resolved conflicts twice. CI seems a bit spurious, could you please check?
@wing328
wing328
commented
Jan 17, 2022

Copy link


Copy Markdown

Member
For the bitrise CI failure, please ignore it.
@wing328
wing328
merged commit 0f6b620
into
OpenAPITools:masterJan 17, 2022
@cachescrubber
cachescrubber
deleted the

feature/relative_imports_pr

branch
January 17, 2022 09:12
@cachescrubbercachescrubber
mentioned this pull request
Jan 17, 2022
 Merged

1 task
@wing328wing328
added this to the 5.4.0 milestone
Jan 31, 2022
@mikkomaunumikkomaunu
mentioned this pull request
Apr 10, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@welshmwelshmwelshm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Enhancement: GeneralIssue: BugServer: JavaServer: Spring

Projects


None yet


Milestone

5.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@cachescrubber@wing328@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[Java Spring OAS3] Minor fixes and general improvements - #11229
Merged
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Jan 17, 2022
Merged
[Java Spring OAS3] Minor fixes and general improvements#11229
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

Contributor
A follow up to #11181. The OAS3 @Operation (Api) and @Schema (Model) annotations have been refined. Also, I did a major cleanup of the mustache templates and the generated source files.
PR checklist
  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [ x] 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 (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
* Use Relative Imports for org.springframework.core.io.Resource
63413b6
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore
@cachescrubber
Add spring-stubs-oas3.yaml test config
6649749
@cachescrubber
Generate all samples
a28c16f
@cachescrubber
cachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Please have a look.
@wing328
wing328
commented
Jan 12, 2022

Copy link


Copy Markdown

Member
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
@welshm
welshm
commented
Jan 12, 2022

Copy link


Copy Markdown

Contributor
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
Will take a look this evening
@cachescrubber
cachescrubber
commented
Jan 12, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 thx for the review. I added a short non JavaDoc comment as you suggested.
@welshm sorry - forgot to notify you of the PR.
welshm
welshm
reviewed
Jan 13, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{#async}}
import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
{{/async}}
import javax.annotation.Generated;
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self; added import because generated annotation is no longer fully qualified
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
 {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
 {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: ApiIgnore added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache

 // Override this method
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: Pageable added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache
 @Valid{{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
 @Valid{{/isPrimitiveType}}{{/isContainer}}
{{>beanValidationCore}}
{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}} No newline at end of file 
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra spaces after @Valid  - doesn't seem like a big deal though
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/enumOuterClass.mustache
 */
{{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
{{>additionalEnumTypeAnnotations}}
{{>generatedAnnotation}}
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New annotation added here
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
 @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
 {{/isDateTime}}
 {{#openApiNullable}}
 private {{>nullableDataType}} {{name}}{{#isNullable}} = JsonNullable.undefined(){{/isNullable}}{{^isNullable}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isNullable}};
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, are there tests for a nullable field?
I had to fix this locally and haven't upstreamed the changes yet but we're also using a generator one version behind
@wing328wing328Jan 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but those tests in the 3.0 spec: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1813
Spring samples (most if not all) are using 2.0 spec at the moment. We'll need to update these config to use the 3.0 spec instead.
@welshmwelshmJan 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look to update that in the coming weeks
@cachescrubbercachescrubberJan 16, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least I introduced test configs for oas3 output format... We could update some of them to use 3.0 as input as well. But this could lead to even more test cases ...
oas2 -> oas2 -> ok

oas2 -> oas3 -> ok

oas3 -> oas2 -> do we even need this?

oas3 -> oas3 -> partially ok. This should be the fokus.
@welshm
welshm
commented
Jan 13, 2022

Copy link


Copy Markdown

Contributor
Overall this looks good to me - just the one comment about useSpringFox but otherwise looks like good cleanup
@wing328
wing328
commented
Jan 13, 2022

Copy link


Copy Markdown

Member
@cachescrubber pls let me know if you need help fixing the merge conflicts as I've reordered the tests (spring, apache camel) a bit in pom.xml.
@cachescrubber
cachescrubber
commented
Jan 13, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I reverted 1915f8b - please check the merge result.
@cachescrubber
Evaluate additional property useSpringfox as Boolean
2a9f955
@cachescrubber
Generate all samples after merge (java-camel)
58065de
@cachescrubber
Fix typo
a46f702
@cachescrubber
Move java-camel test deom samples.circleci.spring to samples.circleci…
11c9c74
… profile.
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
b43e79f
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
e5289bb
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/FileSchemaTestClass.java
@cachescrubber
re-generate all samples after merge
1e801fe
@cachescrubber
Generate samples and docs after merge
ac1496c
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
235a59c
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/File.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/File.java
@cachescrubber
Generate samples after merge conflicts resolved
ee7a1a6
@cachescrubber
cachescrubber
commented
Jan 17, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I merge master and resolved conflicts twice. CI seems a bit spurious, could you please check?
@wing328
wing328
commented
Jan 17, 2022

Copy link


Copy Markdown

Member
For the bitrise CI failure, please ignore it.
@wing328
wing328
merged commit 0f6b620
into
OpenAPITools:masterJan 17, 2022
@cachescrubber
cachescrubber
deleted the

feature/relative_imports_pr

branch
January 17, 2022 09:12
@cachescrubbercachescrubber
mentioned this pull request
Jan 17, 2022
 Merged

1 task
@wing328wing328
added this to the 5.4.0 milestone
Jan 31, 2022
@mikkomaunumikkomaunu
mentioned this pull request
Apr 10, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@welshmwelshmwelshm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Enhancement: GeneralIssue: BugServer: JavaServer: Spring

Projects


None yet


Milestone

5.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@cachescrubber@wing328@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[Java Spring OAS3] Minor fixes and general improvements - #11229
Merged
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Jan 17, 2022
Merged
[Java Spring OAS3] Minor fixes and general improvements#11229
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

Contributor
A follow up to #11181. The OAS3 @Operation (Api) and @Schema (Model) annotations have been refined. Also, I did a major cleanup of the mustache templates and the generated source files.
PR checklist
  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [ x] 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 (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
* Use Relative Imports for org.springframework.core.io.Resource
63413b6
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore
@cachescrubber
Add spring-stubs-oas3.yaml test config
6649749
@cachescrubber
Generate all samples
a28c16f
@cachescrubber
cachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Please have a look.
@wing328
wing328
commented
Jan 12, 2022

Copy link


Copy Markdown

Member
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
@welshm
welshm
commented
Jan 12, 2022

Copy link


Copy Markdown

Contributor
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
Will take a look this evening
@cachescrubber
cachescrubber
commented
Jan 12, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 thx for the review. I added a short non JavaDoc comment as you suggested.
@welshm sorry - forgot to notify you of the PR.
welshm
welshm
reviewed
Jan 13, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{#async}}
import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
{{/async}}
import javax.annotation.Generated;
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self; added import because generated annotation is no longer fully qualified
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
 {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
 {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: ApiIgnore added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache

 // Override this method
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: Pageable added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache
 @Valid{{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
 @Valid{{/isPrimitiveType}}{{/isContainer}}
{{>beanValidationCore}}
{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}} No newline at end of file 
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra spaces after @Valid  - doesn't seem like a big deal though
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/enumOuterClass.mustache
 */
{{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
{{>additionalEnumTypeAnnotations}}
{{>generatedAnnotation}}
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New annotation added here
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
 @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
 {{/isDateTime}}
 {{#openApiNullable}}
 private {{>nullableDataType}} {{name}}{{#isNullable}} = JsonNullable.undefined(){{/isNullable}}{{^isNullable}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isNullable}};
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, are there tests for a nullable field?
I had to fix this locally and haven't upstreamed the changes yet but we're also using a generator one version behind
@wing328wing328Jan 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but those tests in the 3.0 spec: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1813
Spring samples (most if not all) are using 2.0 spec at the moment. We'll need to update these config to use the 3.0 spec instead.
@welshmwelshmJan 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look to update that in the coming weeks
@cachescrubbercachescrubberJan 16, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least I introduced test configs for oas3 output format... We could update some of them to use 3.0 as input as well. But this could lead to even more test cases ...
oas2 -> oas2 -> ok

oas2 -> oas3 -> ok

oas3 -> oas2 -> do we even need this?

oas3 -> oas3 -> partially ok. This should be the fokus.
@welshm
welshm
commented
Jan 13, 2022

Copy link


Copy Markdown

Contributor
Overall this looks good to me - just the one comment about useSpringFox but otherwise looks like good cleanup
@wing328
wing328
commented
Jan 13, 2022

Copy link


Copy Markdown

Member
@cachescrubber pls let me know if you need help fixing the merge conflicts as I've reordered the tests (spring, apache camel) a bit in pom.xml.
@cachescrubber
cachescrubber
commented
Jan 13, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I reverted 1915f8b - please check the merge result.
@cachescrubber
Evaluate additional property useSpringfox as Boolean
2a9f955
@cachescrubber
Generate all samples after merge (java-camel)
58065de
@cachescrubber
Fix typo
a46f702
@cachescrubber
Move java-camel test deom samples.circleci.spring to samples.circleci…
11c9c74
… profile.
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
b43e79f
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
e5289bb
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/FileSchemaTestClass.java
@cachescrubber
re-generate all samples after merge
1e801fe
@cachescrubber
Generate samples and docs after merge
ac1496c
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
235a59c
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/File.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/File.java
@cachescrubber
Generate samples after merge conflicts resolved
ee7a1a6
@cachescrubber
cachescrubber
commented
Jan 17, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I merge master and resolved conflicts twice. CI seems a bit spurious, could you please check?
@wing328
wing328
commented
Jan 17, 2022

Copy link


Copy Markdown

Member
For the bitrise CI failure, please ignore it.
@wing328
wing328
merged commit 0f6b620
into
OpenAPITools:masterJan 17, 2022
@cachescrubber
cachescrubber
deleted the

feature/relative_imports_pr

branch
January 17, 2022 09:12
@cachescrubbercachescrubber
mentioned this pull request
Jan 17, 2022
 Merged

1 task
@wing328wing328
added this to the 5.4.0 milestone
Jan 31, 2022
@mikkomaunumikkomaunu
mentioned this pull request
Apr 10, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@welshmwelshmwelshm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Enhancement: GeneralIssue: BugServer: JavaServer: Spring

Projects


None yet


Milestone

5.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@cachescrubber@wing328@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[Java Spring OAS3] Minor fixes and general improvements - #11229
Merged
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Jan 17, 2022
Merged
[Java Spring OAS3] Minor fixes and general improvements#11229
wing328 merged 17 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/relative_imports_pr
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

Contributor
A follow up to #11181. The OAS3 @Operation (Api) and @Schema (Model) annotations have been refined. Also, I did a major cleanup of the mustache templates and the generated source files.
PR checklist
  • [ x] Read the contribution guidelines.
  • [ x] 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.
  • [ x] 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 (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
* Use Relative Imports for org.springframework.core.io.Resource
63413b6
* api.mustache: Add operationId to atOperation annotation
* Overhaul atSchema annotation in model
* Add spring-stubs-oas3.yaml test config
* Optimize mustache templates
* Use Relative Imports for DateTimeFormat, Pageable and ApiIgnore
@cachescrubber
Add spring-stubs-oas3.yaml test config
6649749
@cachescrubber
Generate all samples
a28c16f
@cachescrubber
cachescrubber
commented
Jan 4, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Please have a look.
@wing328
wing328
commented
Jan 12, 2022

Copy link


Copy Markdown

Member
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
@welshm
welshm
commented
Jan 12, 2022

Copy link


Copy Markdown

Contributor
@cachescrubber thanks for the PR. One minor suggestion is to add some comments (1 or 2 lines) to the fromOperation function explain what it does.
@welshm can you please take a look at this PR as well?
Will take a look this evening
@cachescrubber
cachescrubber
commented
Jan 12, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 thx for the review. I added a short non JavaDoc comment as you suggested.
@welshm sorry - forgot to notify you of the PR.
welshm
welshm
reviewed
Jan 13, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
Outdated

Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
{{#async}}
import java.util.concurrent.{{^jdk8}}Callable{{/jdk8}}{{#jdk8}}CompletableFuture{{/jdk8}};
{{/async}}
import javax.annotation.Generated;
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self; added import because generated annotation is no longer fully qualified
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache
 {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}},
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
 {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore {{/useSpringfox}}final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}
 {{/hasParams}}{{#oas3}}@Parameter(hidden = true){{/oas3}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}{{#hasParams}},
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: ApiIgnore added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/api.mustache

 // Override this method
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@springfox.documentation.annotations.ApiIgnore{{/useSpringfox}} final org.springframework.data.domain.Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
 {{#jdk8-default-interface}}default {{/jdk8-default-interface}} {{#responseWrapper}}{{.}}<{{/responseWrapper}}ResponseEntity<{{>returnTypes}}>{{#responseWrapper}}>{{/responseWrapper}} {{operationId}}({{#allParams}}{{^isFile}}{{^isBodyParam}}{{>optionalDataType}}{{/isBodyParam}}{{#isBodyParam}}{{^reactive}}{{{dataType}}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}}{{/isBodyParam}}{{/isFile}}{{#isFile}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#reactive}}{{#hasParams}}, {{/hasParams}}{{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final ServerWebExchange exchange{{/reactive}}{{#vendorExtensions.x-spring-paginated}}, {{#useSpringfox}}@ApiIgnore{{/useSpringfox}} final Pageable pageable{{/vendorExtensions.x-spring-paginated}}){{#unhandledException}} throws Exception{{/unhandledException}} {
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to self: Pageable added to imports
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache
 @Valid{{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}
 @Valid{{/isPrimitiveType}}{{/isContainer}}
{{>beanValidationCore}}
{{#required}}@NotNull {{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}} No newline at end of file 
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added extra spaces after @Valid  - doesn't seem like a big deal though
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/enumOuterClass.mustache
 */
{{>additionalEnumTypeAnnotations}}public enum {{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}} {
{{>additionalEnumTypeAnnotations}}
{{>generatedAnnotation}}
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New annotation added here
Comment threadmodules/openapi-generator/src/main/resources/JavaSpring/pojo.mustache
 @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
 {{/isDateTime}}
 {{#openApiNullable}}
 private {{>nullableDataType}} {{name}}{{#isNullable}} = JsonNullable.undefined(){{/isNullable}}{{^isNullable}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isNullable}};
@welshmwelshmJan 13, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, are there tests for a nullable field?
I had to fix this locally and haven't upstreamed the changes yet but we're also using a generator one version behind
@wing328wing328Jan 16, 2022

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but those tests in the 3.0 spec: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1813
Spring samples (most if not all) are using 2.0 spec at the moment. We'll need to update these config to use the 3.0 spec instead.
@welshmwelshmJan 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look to update that in the coming weeks
@cachescrubbercachescrubberJan 16, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least I introduced test configs for oas3 output format... We could update some of them to use 3.0 as input as well. But this could lead to even more test cases ...
oas2 -> oas2 -> ok

oas2 -> oas3 -> ok

oas3 -> oas2 -> do we even need this?

oas3 -> oas3 -> partially ok. This should be the fokus.
@welshm
welshm
commented
Jan 13, 2022

Copy link


Copy Markdown

Contributor
Overall this looks good to me - just the one comment about useSpringFox but otherwise looks like good cleanup
@wing328
wing328
commented
Jan 13, 2022

Copy link


Copy Markdown

Member
@cachescrubber pls let me know if you need help fixing the merge conflicts as I've reordered the tests (spring, apache camel) a bit in pom.xml.
@cachescrubber
cachescrubber
commented
Jan 13, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I reverted 1915f8b - please check the merge result.
@cachescrubber
Evaluate additional property useSpringfox as Boolean
2a9f955
@cachescrubber
Generate all samples after merge (java-camel)
58065de
@cachescrubber
Fix typo
a46f702
@cachescrubber
Move java-camel test deom samples.circleci.spring to samples.circleci…
11c9c74
… profile.
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
b43e79f
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
e5289bb
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/FileSchemaTestClass.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/FileSchemaTestClass.java
@cachescrubber
re-generate all samples after merge
1e801fe
@cachescrubber
Generate samples and docs after merge
ac1496c
@cachescrubber
Merge branch 'master' into feature/relative_imports_pr
235a59c
# Conflicts:
#	samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-beanvalidation/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-reactive/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-spring-pageable/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-useoptional/src/main/java/org/openapitools/model/File.java
#	samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/model/File.java
#	samples/server/petstore/springboot/src/main/java/org/openapitools/model/File.java
@cachescrubber
Generate samples after merge conflicts resolved
ee7a1a6
@cachescrubber
cachescrubber
commented
Jan 17, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 I merge master and resolved conflicts twice. CI seems a bit spurious, could you please check?
@wing328
wing328
commented
Jan 17, 2022

Copy link


Copy Markdown

Member
For the bitrise CI failure, please ignore it.
@wing328
wing328
merged commit 0f6b620
into
OpenAPITools:masterJan 17, 2022
@cachescrubber
cachescrubber
deleted the

feature/relative_imports_pr

branch
January 17, 2022 09:12
@cachescrubbercachescrubber
mentioned this pull request
Jan 17, 2022
 Merged

1 task
@wing328wing328
added this to the 5.4.0 milestone
Jan 31, 2022
@mikkomaunumikkomaunu
mentioned this pull request
Apr 10, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@welshmwelshmwelshm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Enhancement: GeneralIssue: BugServer: JavaServer: Spring

Projects


None yet


Milestone

5.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@cachescrubber@wing328@welshm