Operation parameters generated in incorrect order

[dylangleason]

My swagger document has the following API operation:

{
            "path":"/v1/createUser",
            "description":"Adds a new subaccount user to the current account",
            "operations":[
                {
                    "method":"GET",
                    "summary":"Adds a new subaccount user to the current account",
                    "nickname":"createUser",
                    "type":"Response",
                    "parameters":[
                        {
                            "paramType":"query",
                            "name":"access_token",
                            "type":"string",
                            "required":true,
                            "description":"Access token required to make the API call"
                        },
                        {
                            "paramType":"query",
                            "name":"username",
                            "type":"string",
                            "required":true,
                            "description":"Name of the subaccount user to create"
                        },
                        {
                            "paramType":"query",
                            "name":"destinationFolder",
                            "type":"string",
                            "required":true,
                            "description":"The user's home folder"
                        },
                        {
                            "paramType":"query",
                            "name":"email",
                            "type":"string",
                            "required":true,
                            "description":"The user's email address"
                        },
                        {
                            "paramType":"query",
                            "name":"password",
                            "type":"string",
                            "required":true,
                            "description":"The user's password"
                        },
                        {
                            "paramType":"query",
                            "name":"role",
                            "type":"string",
                            "required":true,
                            "description":"The user's role, i.e: 'user' or 'admin'"
                        },
                        {
                            "paramType":"query",
                            "name":"permissions",
                            "type":"array",
                            "required":true,
                            "description":"An array of permissions for the user. The following values are supported: upload, download, delete, modify, list, changePassword, share, notification",
                            "items":{
                                "type":"string"
                            }
                        },
                        {
                            "paramType":"query",
                            "name":"timeZone",
                            "type":"string",
                            "required":true,
                            "description":"The user's timezone, used for accurate time display within SWFT. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values",
                            "defaultValue":"America/Los_Angeles"
                        },
                        {
                            "paramType":"query",
                            "name":"nickname",
                            "type":"string",
                            "description":"The user's nickname"
                        },
                        {
                            "paramType":"query",
                            "name":"locked",
                            "type":"string",
                            "description":"If true, the user's account is locked by default"
                        },
                        {
                            "paramType":"query",
                            "name":"welcomeEmail",
                            "type":"string",
                            "description":"If true, send a user email upon creation"
                        }
                    ],
                    "notes":"Requires access token obtained via the authenticateUser operation. Available to users with the 'manage users' permission"
                }
            ]
        }

However, the generated code seems to declare one of the parameters in incorrect order:

public function createUser($access_token, $username, $destinationFolder, $email, $password, $role, $permissions, $nickname=null, $locked=null, $welcomeEmail=null, $timeZone)  { //.... }

Though $timeZone was specified immediately after $permissions, it appears that swagger-codegen reordered this and placed it on the end.

[fehguy]

Hi, this is because codegen will put all the required parameters first, then optional afterwards. This is by design--is it causing you trouble?

[dylangleason]

Your explanation makes sense, but doesn't describe my situation. In the above, timeZone is a required parameter, but is the very last parameter listed in the createUser method in the generated PHP code.

This could be problematic since the documentation per the JSON resource shows the correct order, while the PHP client does not, so it could confuse users who are trying to use the PHP client and using the swagger-ui documentation as a reference.

[kc284]

Unfortunately this is causing me (and probably others) a lot of grief. I upgraded from swagger-codegen-distribution 2.1.2-M1 to swagger-codegen-cli 2.1.3 and my method signatures got messed up breaking existing integrations. It makes much more sense to me to output the parameters in the order stated in the json file. What exactly was the reasoning behind this change?

[wing328]

@kc284 sorry to hear that it's breaking your application due to the change in method signature. We'll provide an option to make the change backward compatible (which means the parameter order is kept).

[wing328]

@kc284 I've filed #1272 so that you can pass sortParamsByRequiredFlag in a config file (json) to disable sorting the method argument. Please take a look to see if that would meet your requirement.

[kc284]

@wing328 yes, this solves my issue, thanks.

[wing328]

@kc284 PR merged into master.

[ephrin]

It would be nice if we'd be able to specify configuration flag to use object parameters with fluent setters to be generated. Apart from model. That kind of functionality might leverage backward compatibility for a longer time.