[Spring][server] oneOf Polymorphism support for spring boot #5661

alexsuperdev · 2020-03-22T10:53:19Z

Fix 5381
Implemented OneOf for java spring library(server side).

PR checklist

Read the contribution guidelines.
If contributing template-only or documentation-only changes which will change sample output, build the project before.
Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @bkabrda

added x-is-one-of-interface extension for oneOf interface in mustache template

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix OpenAPITools#5381 parcelableModel is not required

removed not needed methods

catch NPE cases in preprocessOpenAPI updated samples

…rator into spring_fix_5381

bkabrda

Hey 👋 this mostly looks good, but I left 2 questions and 1 comment in the code to get answered/addressed.

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

modules/openapi-generator/src/main/resources/JavaSpring/oneof_interface.mustache

fixed generation of oneOf Models

addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring

NPE fix

…rator into spring_fix_5381

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

spring: fixed use of oneOf Models in API

scazacioc · 2020-03-27T01:41:45Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -764,7 +769,7 @@ public void preprocessOpenAPI(OpenAPI openAPI) {
                Schema s = e.getValue();
                String nOneOf = toModelName(n + "OneOf");
                if (ModelUtils.isComposedSchema(s)) {
-                    if (e.getKey().contains("/")) {
+                    if (e.getKey().contains("/") || (useOneOfInterfaces && LIBRARY_ONEOF_IMPL.equals(templateDir))) {


The code is specific to the SpringCodegen class and must be written in it???

Yes, the code will be executed only for java spring library, as the specification of this issue require.

If so, move the code in SpringCodegen.java and all if statments with (.... templateDir.equals(LIBRARY_ONEOF_IMPL....) should be in SpringCodegen.java

To do it so, i must duplicate almost the whole preprocessOpenAPI method in SpringCodegen, only because of this condition. I wanted to avoid it

@Scorpioncik should i do so?

You don't need to duplicate the whole preprocessOpenAPI, you can extract in a method the piece of code and override it in SpringCodegen.

example:
if (e.getKey().contains("/")) { ====> if (method1()) {

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

implementing oneOf for spring lib overriding methods with different behavior from default

scazacioc · 2020-03-30T19:39:54Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

+    @Override
+    protected void addOneOfForComposedSchema(Entry<String, Schema> stringSchemaEntry, String modelName, ComposedSchema composedSchema,
+        String nOneOf){
+        if (useOneOfInterfaces) {


useOneOfInterfaces is always true?

yes, you are right useOneOfInterfaces is always true, i will change the code, that there is no if cases anymore.

do you mean this?

@Scorpioncik please review this pull request again.

added x-is-one-of-interface extension for oneOf interface in mustache template

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix OpenAPITools#5381 removed not needed methods Fix OpenAPITools#5381 fixed generation of oneOf Models Fix OpenAPITools#5381 addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring Fix OpenAPITools#5381 NPE fix for tests

fixed handing of composed schema with array

fixed NPE in addOneOfInterfaceModel

jburgess · 2020-04-02T02:48:57Z

@alexsuperdev Thanks for you work on this!! I have been monitoring it closely and have been using your fork for testing both oneOf and discriminator patterns. I understand this fork may still be a WIP, but, I have noticed since @bfab304 my code gen has started to fail for the discriminator pattern of extension. I have created a simple OAS that captures the failure. The models are now (d8648310) being generated as empty interfaces:

public interface Cat  {
}

Would you mind running the below OAS with your codebase?

openapi: 3.0.1
info:
  title: OneOfTest01
  description: >+
    This test illustrates an issue with inheritance

  version: 4.0.0
servers:
  - url: 'https://serverRoot'

paths:
  /pets:
    get:
      responses:
        '200':
          $ref: '#/components/responses/PetResponse'
    post:
      requestBody:
        $ref: '#/components/requestBodies/PetRequest'
      responses:
        '201':
          $ref: '#/components/responses/PetResponse'
components:
  schemas:
    Pet:
      type: object
      properties:
        basePetProperty:
          type: string
        id:
          type: string
        petType:
          type: string
      discriminator:
        propertyName: 'petType'
        mapping:
          cat: '#/components/schemas/Cat'
          dog: '#/components/schemas/Dog'

    Cat:
      type: object
      properties:
        catProperty:
          type: string
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
    Dog:
      type: object
      properties:
        dogProperty:
          type: string
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object

  requestBodies:
    PetRequest:
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/Pet'
      required: true

  responses:
    PetResponse:
      description: Success
      content:
        application/json;charset=utf-8:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Pet'

fixed generation of oneOf models with descriminator

alexsuperdev · 2020-04-02T20:13:48Z

@alexsuperdev Thanks for you work on this!! I have been monitoring it closely and have been using your fork for testing both oneOf and discriminator patterns. I understand this fork may still be a WIP, but, I have noticed since @bfab304 my code gen has started to fail for the discriminator pattern of extension. I have created a simple OAS that captures the failure. The models are now (d8648310) being generated as empty interfaces:

public interface Cat  {
}

Would you mind running the below OAS with your codebase?

openapi: 3.0.1
info:
  title: OneOfTest01
  description: >+
    This test illustrates an issue with inheritance

  version: 4.0.0
servers:
  - url: 'https://serverRoot'

paths:
  /pets:
    get:
      responses:
        '200':
          $ref: '#/components/responses/PetResponse'
    post:
      requestBody:
        $ref: '#/components/requestBodies/PetRequest'
      responses:
        '201':
          $ref: '#/components/responses/PetResponse'
components:
  schemas:
    Pet:
      type: object
      properties:
        basePetProperty:
          type: string
        id:
          type: string
        petType:
          type: string
      discriminator:
        propertyName: 'petType'
        mapping:
          cat: '#/components/schemas/Cat'
          dog: '#/components/schemas/Dog'

    Cat:
      type: object
      properties:
        catProperty:
          type: string
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
    Dog:
      type: object
      properties:
        dogProperty:
          type: string
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object

  requestBodies:
    PetRequest:
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/Pet'
      required: true

  responses:
    PetResponse:
      description: Success
      content:
        application/json;charset=utf-8:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Pet'

Thank you @jburgess also for the tip and example with discriminator.
I made a little change, so now the generated classes from your example seem to be okay for me.
I tested it locally. Please proove it.

jburgess · 2020-04-02T21:01:53Z

@alexsuperdev, yes. This seems to have resolved this issue. Thanks!

alexsuperdev · 2020-04-05T20:01:06Z

Hello @bkabrda @Scorpioncik @jburgess @jimschubert. Can any one of you review this pullrequest?

nielicheng · 2020-09-28T06:35:18Z

Hi @alexsuperdev Thanks for working on this. Do we have an ETA when this fix will be merged?

alexsuperdev · 2020-10-11T16:23:32Z

Hi @alexsuperdev Thanks for working on this. Do we have an ETA when this fix will be merged?

I dont know when @bkabrda or @jimschubert have a time to look in this pull request and merge this

ghost · 2020-12-03T08:39:53Z

Is there anything new about this? I only mean because 224 PRs are waiting at the moment. So I have little hope to ever see the fix...

adzeeman · 2021-02-03T13:59:26Z

@alexsuperdev Thank you for taking the initiative on implementing this feature - are you still planning on completing this piece of work. It seems that there are maybe people interested in this feature (myself being one of them).

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

alexsuperdev · 2021-02-03T22:34:17Z

@alexsuperdev Thank you for taking the initiative on implementing this feature - are you still planning on completing this piece of work. It seems that there are maybe people interested in this feature (myself being one of them).

hello @adzeeman. I will try to fix merge conflicts and possibly junit tests this week

…rator into spring_fix_5381

… npe

ghost · 2021-03-10T09:52:24Z

Us SadaPay engineers are very keen to get this merged ASAP - let us know how we can support.

Bellegar · 2021-03-14T21:27:48Z

It seems that pojo.mustache must be the same as in #8091, it adds "implementats .." to Java class definition

public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}}{{^parent}}{{#hateoas}}extends RepresentationModel<{{classname}}> {{/hateoas}}{{/parent}} {{#serializableModel}}implements Serializable{{/serializableModel}} {

-->

public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}}{{^parent}}{{#hateoas}}extends RepresentationModel<{{classname}}> {{/hateoas}}{{/parent}} {{#vendorExtensions.x-implements}}{{#-first}}implements {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{#-last}} {{/-last}}{{/vendorExtensions.x-implements}} {

alexsuperdev · 2021-04-27T19:54:14Z

Hello Andreas, thank you for this message. Yes, its very said, that the the simple merge could not be done yet. Very useful information about Swagger codegen, maybe i will switch also to Swagger codegen. Am Do., 22. Apr. 2021 um 12:16 Uhr schrieb andreas-whc < ***@***.***>:

…

Hello Alexei, thank you for your great work. That's a real shame that the PR was taken out to make an early hotfix out of a release. Very disappointing release management. We probably decided to switch back to Swagger codegen soon because of this :( Real shame. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5661 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AF4EPWLKHJ4MV6GWPCUI7GTTJ7ZRHANCNFSM4LRH4LRA> .

jorgerod · 2021-06-02T07:23:41Z

Hi

Any news? This feature is very important for us.
@bkabrda @Scorpioncik @alexsuperdev @jimschubert

rj93 · 2021-06-14T12:46:58Z

any news?

daberni · 2021-07-01T07:44:23Z

Anything we can help with getting the pull request merged? Is there any open issue in the pull request or are we waiting for the maintainers?

alexsuperdev · 2021-07-02T14:54:41Z

Anything we can help with getting the pull request merged? Is there any open issue in the pull request or are we waiting for the maintainers?

I also really don't know why this PR will not be merged by maintainers

daberni · 2021-07-02T15:48:25Z

Anything we can help with getting the pull request merged? Is there any open issue in the pull request or are we waiting for the maintainers?

I also really don't know why this PR will not be merged by maintainers

looks like there are 2 merge conflicts left, maybe you could fix them to increase the chance for a merge?

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java � modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

swathisprasad · 2021-07-12T21:09:05Z

Hi @alexsuperdev,
Thanks for working on this! Are there any updates when this fix will be merged?

alexsuperdev · 2021-07-13T20:58:02Z

Hi @alexsuperdev,
Thanks for working on this! Are there any updates when this fix will be merged?

Its too much changes that need to be manually merged, i don't want to do it, because after it, PR possibly will not be merged by maintainers also. So if someone want to do merge it, you are welcome

petlju · 2022-04-04T09:56:16Z

Never contributed to someone else's pull request before. Do I fork your fork and fix it there and do a pull request to your fork? Or how does one go about contributing to someone else's?

ViaSacra · 2022-08-22T12:08:46Z

Colleagues, when will this functionality be released? He is sorely missed!

samiron · 2024-01-25T20:13:46Z

Is there any chance to get this PR merged any time sooner?

alexsuperdev · 2024-01-26T20:52:25Z

Is there any chance to get this PR merged any time sooner?
As i understood #11650 have fixed the problem with oneOf and was already merged

alexsuperdev added 5 commits March 22, 2020 11:15

Fix OpenAPITools#5381

6a8769e

added x-is-one-of-interface extension for oneOf interface in mustache template

Fix OpenAPITools#5381

049359c

fixed name of model from UNKNOWN_BASE_TYPE to right one in api: operationId + OneOf Fix OpenAPITools#5381 parcelableModel is not required

Fix OpenAPITools#5381

49f13eb

removed not needed methods

Fix OpenAPITools#5381

1a5a484

catch NPE cases in preprocessOpenAPI updated samples

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

66a09d2

…rator into spring_fix_5381

alexsuperdev changed the title ~~Spring fix 5381~~ [Java][Spring] fix 5381 Mar 22, 2020

alexsuperdev changed the title ~~[Java][Spring] fix 5381~~ [Spring][server] oneOf Polymorphism support for spring boot Mar 22, 2020

vvb mentioned this pull request Mar 22, 2020

[powershell-experimental] Protects against stackoverflow when OAS spec has circular references #5646

Merged

5 tasks

bkabrda reviewed Mar 24, 2020

View reviewed changes

alexsuperdev added 6 commits March 24, 2020 22:14

Fix OpenAPITools#5381

48a1a4a

fixed generation of oneOf Models

Fix OpenAPITools#5381

a811330

addOneOfInterfaceModel only for cases when useOneOfInterfaces is true and for spring

Fix OpenAPITools#5381

299cdb3

NPE fix

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

461cbc8

…rator into spring_fix_5381

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

dd0118d

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

Fix OpenAPITools#5381

26a95f6

spring: fixed use of oneOf Models in API

scazacioc reviewed Mar 27, 2020

View reviewed changes

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java Outdated Show resolved Hide resolved

Fix OpenAPITools#5381

9af7db6

implementing oneOf for spring lib overriding methods with different behavior from default

scazacioc reviewed Mar 30, 2020

View reviewed changes

alexsuperdev added 2 commits March 31, 2020 21:23

Fix OpenAPITools#5381

fbfd57d

added x-is-one-of-interface extension for oneOf interface in mustache template

alexsuperdev requested a review from jimschubert as a code owner March 31, 2020 19:43

alexsuperdev force-pushed the spring_fix_5381 branch from 83ff1ee to bfab304 Compare April 1, 2020 18:24

alexsuperdev added 2 commits April 1, 2020 21:22

Fix OpenAPITools#5381

29003d8

fixed handing of composed schema with array

Fix OpenAPITools#5381

d864831

fixed NPE in addOneOfInterfaceModel

Fix OpenAPITools#5381

6d54799

fixed generation of oneOf models with descriminator

alexsuperdev reopened this May 23, 2020

rmberne mentioned this pull request Jul 16, 2020

Fix oneOf interfaces for Java projects rmberne/openapi-generator#1

Closed

5 tasks

jburgess mentioned this pull request Dec 3, 2020

[Spring][server] oneOf Interface for Spring Boot #8091

Closed

6 tasks

alexsuperdev added 2 commits February 3, 2021 22:52

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

fe7fd56

…rator into spring_fix_5381 � Conflicts: � modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

[Spring] codegen : oneOf support for spring (OpenAPITools#5381)

9b586fa

alexsuperdev added 2 commits February 4, 2021 21:15

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

07df40c

…rator into spring_fix_5381

[Spring] codegen : oneOf support for spring (OpenAPITools#5381) avoid…

15b362a

… npe

zarsky-broad mentioned this pull request Feb 4, 2021

[PF-308] Add GCS bucket and bigquery data references DataBiosphere/terra-workspace-manager#212

Merged

This was referenced Jul 20, 2021

[BUG] [Spring] OneOf base class not generated #9981

Open

[BUG] [Spring] OneOf base class not generated (#9981) #10009

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Spring][server] oneOf Polymorphism support for spring boot #5661

[Spring][server] oneOf Polymorphism support for spring boot #5661

alexsuperdev commented Mar 22, 2020 •

edited

Loading

bkabrda left a comment

scazacioc Mar 27, 2020

alexsuperdev Mar 27, 2020

scazacioc Mar 27, 2020

alexsuperdev Mar 27, 2020

alexsuperdev Mar 30, 2020

scazacioc Mar 30, 2020

scazacioc Mar 30, 2020

alexsuperdev Mar 30, 2020

alexsuperdev Mar 30, 2020

alexsuperdev Apr 5, 2020

jburgess commented Apr 2, 2020

alexsuperdev commented Apr 2, 2020

jburgess commented Apr 2, 2020

alexsuperdev commented Apr 5, 2020

nielicheng commented Sep 28, 2020

alexsuperdev commented Oct 11, 2020

ghost commented Dec 3, 2020

adzeeman commented Feb 3, 2021 •

edited

Loading

alexsuperdev commented Feb 3, 2021 •

edited

Loading

ghost commented Mar 10, 2021

Bellegar commented Mar 14, 2021

alexsuperdev commented Apr 27, 2021 via email

jorgerod commented Jun 2, 2021

rj93 commented Jun 14, 2021

daberni commented Jul 1, 2021

alexsuperdev commented Jul 2, 2021

daberni commented Jul 2, 2021

swathisprasad commented Jul 12, 2021

alexsuperdev commented Jul 13, 2021

petlju commented Apr 4, 2022

ViaSacra commented Aug 22, 2022

samiron commented Jan 25, 2024

alexsuperdev commented Jan 26, 2024 •

edited

Loading

[Spring][server] oneOf Polymorphism support for spring boot #5661

Are you sure you want to change the base?

[Spring][server] oneOf Polymorphism support for spring boot #5661

Conversation

alexsuperdev commented Mar 22, 2020 • edited Loading

PR checklist

bkabrda left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jburgess commented Apr 2, 2020

alexsuperdev commented Apr 2, 2020

jburgess commented Apr 2, 2020

alexsuperdev commented Apr 5, 2020

nielicheng commented Sep 28, 2020

alexsuperdev commented Oct 11, 2020

ghost commented Dec 3, 2020

adzeeman commented Feb 3, 2021 • edited Loading

alexsuperdev commented Feb 3, 2021 • edited Loading

ghost commented Mar 10, 2021

Bellegar commented Mar 14, 2021

alexsuperdev commented Apr 27, 2021 via email

jorgerod commented Jun 2, 2021

rj93 commented Jun 14, 2021

daberni commented Jul 1, 2021

alexsuperdev commented Jul 2, 2021

daberni commented Jul 2, 2021

swathisprasad commented Jul 12, 2021

alexsuperdev commented Jul 13, 2021

petlju commented Apr 4, 2022

ViaSacra commented Aug 22, 2022

samiron commented Jan 25, 2024

alexsuperdev commented Jan 26, 2024 • edited Loading

alexsuperdev commented Mar 22, 2020 •

edited

Loading

adzeeman commented Feb 3, 2021 •

edited

Loading

alexsuperdev commented Feb 3, 2021 •

edited

Loading

alexsuperdev commented Jan 26, 2024 •

edited

Loading