Single fielded oneof

[dfithian]

@joel-bach

Not sure if this is the best way. At work using Rust's aide package we'll have a lot of enums like this:

enum MyType {
    Left(LeftType)
    Right(RightType)
}

Which generate this:

MyType:
  oneOf:
    - type: object
      required:
        - left
      properties:
        left:
          $ref: '#/components/schemas/LeftType'
    - type: object
      required:
        - right
      properties:
        right:
          $ref: '#/components/schemas/RightType'

Using this generator it tends to generate enumerations with a lot of OneofN suffixes, but with this feature it'll generate them with Left and Right suffixes instead.

[joel-bach]

Hey @dfithian

Generally, it is hard to give these types good names generically, so I do not see a way around some special casing (which we already have in place with the fixed value schemas). Your case looks reasonable to me, so I think this is an improvement as the indexed OneOf types are nearly useless. I even wonder if we should enable the option by default as it should only improve existing cases (having the flag though is good so peeps can revert to the previous version if needed).

At least I'd be interested to see how the changes behave in the golden tests. Since you'll have to update the golden result anyway, would you mind also adding the flag here?

Haskell-OpenAPI-Client-Code-Generator/nix/tests.nix

Line 14 in db004b9

goldenTestCode = generateCode { fileName = "z_complex_self_made_example.yml"; extraFlags = [ "--output-all-schemas" ]; };

Could you also add a single field object schema outside a oneOf case to make it visible that the new code does not affect that?

Thank you!

[dfithian]

I am happy to make it the default behavior. Would you like me to increment the version to 0.2.0.0 or would you prefer to handle any version rev?

[joel-bach]

I am happy to make it the default behavior. Would you like me to increment the version to 0.2.0.0 or would you prefer to handle any version rev?

Yeah, let's increase the version 👍

[dfithian]

Alright, tests are passing!

[joel-bach]

Nice work, thank you @dfithian !