[Suggestion] Generated model properties should respect nullable and required options

[gratzl-dev]

Hello!

Currently all component properties are treated as non-nullable required fields, regardless of the required schema configurations and only setting fields nullable if nullable is explicitly set to "true".

I would suggest treating all fields as nullable, non required except when specifically specified as such.

For example, the output for this LoginDTO

      "LoginDTO": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "password": {
            "type": "string"
          }
        }
      },

currently is

    @JsonKey(name: LoginDTO.usernameKey) required String username,
    @JsonKey(name: LoginDTO.passwordKey) required String password,

even though neither of the fields are set as required in the spec

With my suggestion it would be generated to this:

    @JsonKey(name: LoginDTO.usernameKey) String? username,
    @JsonKey(name: LoginDTO.passwordKey) String? password,

And to generate the required properties we would use a spec such as:

      "LoginDTO": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "password": {
            "type": "string"
          }
        },
        "required": ["username", "password"]
      },

otherwise these fields should be treated as non required and nullable.

One exception to this would be if "nullable" is explicitly set to "false"

For example, this

      "LoginDTO": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string",
            "nullable": false
          },
          "password": {
            "type": "string"
          }
        },
        "required": [
          "password"
        ]
      },

would then result to

    @JsonKey(name: LoginDTO.usernameKey) String username,
    @JsonKey(name: LoginDTO.passwordKey) required String password,

Thoughts or suggestions on this?

I also modified the code in my fork to behave as suggested.
Maybe make the behaviour configurable?

[rperne]

Hi @gratzl-dev your suggestion addresses a problem similar to my issue #50
so I tried your fork, thank you for sharing!

It has a few commit behind but I could try it, and it contains - for my case - a problem : if a field is required:true, but with no "nullable" field in the schema, it is marked as optional. I have to specify nullable:false in the schema for it to be really required

"parameters": [
          {
            "name": "userId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "nullable": false
            }
          }
        ]

but false is the default value so it is redundant : https://spec.openapis.org/oas/v3.0.3#schemaNullable

what am I missing?

[gratzl-dev]

Hi @rperne :)

This issue is only related to model outputs, not query or path parameters as in your provided example.

Did my fork change the behaviour of params generation aswell?

[rperne]

Yes it did :)
Here is the generated client part if I remove "nullable":false from the sample I shared before

    @Path("userId") required String? userId,

It is still required, but nullable as well

[gratzl-dev]

Oh
Yeah when it's required it should be not nullable by default, I agree

When I find the time I'll sync my fork and try to fix what I broke 😃