shouldn't the fact a property of a schema object is required reflect in the model object itself?

[altmky]

For example in the Java binding, we do have the annotation that indicates the property is required, but if I'm not mistaken you can still not set it and call the API without the model object warning you you have not provided a required property?

For swift binding the property could be a regular one instead of being a swift optional property to force the user of the API to provide it?

[wing328]

Can you please elaborate on the issue by giving an example?

[altmky]

Sorry for not being clear. I meant that with petstore, despite Pet name being "required", I can do:

        Pet pet = new Pet();
        pet.setId(newPetId);
        // name commented out
        // pet.setName("profiler");
        pet.setStatus(Pet.StatusEnum.AVAILABLE);
        pet.setPhotoUrls(Arrays.asList("http://profiler.com"));

        PetApi.add(pet);

without the client-side API complaining about me creating an incomplete (wrt Swagger spec) model object (no name).

I guess there are several ways to deal with that, one being to force required parameters in the model object constructor? (and in Swift you could use mandatory field for that, instead of optional one as you use now for everything?)

I hope this is clearer.

[wing328]

@altmky thanks for the details. Currently, name in Pet is defined as

    public var name: String?

How would you modify it to make it mandatory in Swift?

[Edubits]

In most situations it would be great if the model uses required properties where possible, it will save you quite some Optional unwrapping when using it. However a potential concern with making properties required in the generated API model is update API calls. These regularly work by just sending the properties which should change (and being merged on the server side), this situation wouldn't be possible if properties are required on the client side.

[wing328]

I think we need to update the following lines:

    {{#vars}}{{#isEnum}}{{#description}}/** {{description}} */
    {{/description}}public var {{name}}: {{{datatypeWithEnum}}}{{^unwrapRequired}}?{{/unwrapRequired}}{{#unwrapRequired}}{{^required}}?{{/required}}{{#required}}!{{/required}}{{/unwrapRequired}}{{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}}{{/isEnum}}{{^isEnum}}{{#description}}/** {{description}} */
    {{/description}}public var {{name}}: {{{datatype}}}{{^unwrapRequired}}?{{/unwrapRequired}}{{#unwrapRequired}}{{^required}}?{{/required}}{{#required}}!{{/required}}{{/unwrapRequired}}{{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}}{{/isEnum}}
    {{/vars}}

as I couldn't find any mustache tab/variable for unwrapRequired (and that's why there's always ? for all model properties)

Let's say we remove ? from the name property in the Pet model. I think we also need to update the default constructor as well

Anyone has a clue how the default constructor should be updated (using the Pet model as an example)?

[larslockefeer]

In that case name should be provided as a parameter to the constructor and assigned to the name property, otherwise the class won't compile. Hence:

init(name: String) {
  self.name = name
}

Such a parameter would have to be added for each non-optional property of the model.

[wing328]

@larslockefeer thanks for suggesting the change. May I know if you've cycle to contribute a fix?

Ref: https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md

[bobrosoft]

Try this patch out patch.txt I done Unit Tests with newly generated models on my project -- all passed and models looks correct, no explicit initialization needed in init method.

Possibly patch is not full, I deleted some {{unwrapRequired}} stuff but it's still there below in encodeToJSON method. Speaking truly, I dunno where {{unwrapRequired}} defined (if at all) and what it doing. Also, recommend to mark encodeToJSON method as public — need that in some places where need to prepare JSON payloads manually (patched our company fork for it) to pass them as strings.

[wing328]

@bobrosoft thanks! Do you mind submitting a PR for the change? just want to make sure the credit goes back to your github account.

Ref: https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md

[bobrosoft]

@wing328 can do tomorrow. Btw, do you know somebody who knows about {{unwrapRequired}} to properly check PR? Maybe it been needed for something important there.

[wing328]

I think it can be removed as I don't see any other reference to it. Please feel free to remove it.

[wing328]

Sorry I was wrong. unwrapRequired can be specified in the config:

    unwrapRequired
        Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema

(java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l swift)

[bobrosoft]

Oh, ok, makes sense now, then that patch not needed and that can be controlled through config. Issue can be closed.

For others: when generate there's possibility to specify JSON config file with -c option. To make models use "required" properties, you can set unwrapRequired property to true, as {"unwrapRequired": true, ....<your other options>} in config file for swift generator. To list all available options use:
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l swift