Add sortFields = true|false to disable sorting when generating the model

[nimo23]

Orval generates *.ts model files from a given openapi.yml. However, the fields within the *.ts model interface/type are always sorted implicitly instead of using the field order defined in openapi.yml. For example:

What are the steps to reproduce this issue?

1.openapi.yml has a User endpoint with the following

openapi: 3.1.0
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        password:
          type: string

2. let orval generate the user.ts and look at the ordering of the fields:

// overal sorts the fields in alphabetical order
export interface User {
  id?: string;
  password?: string;
  username?: string;
}

Please add a configuration to https://orval.dev/reference/configuration/output, e.g. sortFields = true|false. If set to false, the field order should match the order defined in openapi.yml. In the above example, it should be:

// sortFields=false, i.e. overal uses the sorting order as defined in openapi.yml
export interface User {
  id?: string;
  username?: string;
  password?: string;
}

What versions are you using?

Orval v 7.3.0

[melloware]

Similar to this issue too: #1382 I think in general everything should be sorted alpha if possible and this new flag suggested by @nimo23 would basically ignore all sorting...

[nimo23]

I think in general everything should be sorted alpha if possible

I think Orval should not deviate from the sorting specified in openapi.yml unless the user explicitly sets it via sortFields=true., i.e. the specified sorting from openapi.yml should be used by default.

[melloware]

PR is welcome...

[nimo23]

I have looked at the code and am trying to figure out which steps are necessary and which files need to be adjusted:

1. add sortFields to either OverrideOutput or OutputOptions in packages.core.src.generators.types.ts
2. where to put it in packages.core.src.generators.options.ts
3. where is the current (alphabetical) sorting of the (generated) properties ? Anywhere in packages.core.src.writers ?
4. Add test case
5. Add documentation in https://github.com/orval-labs/orval/blob/master/docs/src/pages/reference/configuration/output.md

I think someone who knows the code in detail can do it faster than the explanation :)

Btw, maybe there is already a setting in https://github.com/OpenAPITools/openapi-generator (which orval uses (or can use) under the hood)?