Sort paths by tags/operationId?

[af-mikecrowe]

Is it possible to sort the paths deterministically? I'm thinking by tags then operationId?

[thim81]

Hi @af-mikecrowe

Currently openapi-format sorts the elements within OpenAPI in a certain order, for example as defined in the default

[af-mikecrowe]

Right -- My question: Is it possible to expand to sort another level down? So, organize paths by Tag + OperationId, etc.

[thim81]

@af-mikecrowe

I have to review the sorting logic, since currently it does 1 sort for all elements on 1 level.

[thim81]

hi @af-mikecrowe

I added the option to sort paths alphabetically or by tag, by passing --sortFile with sortPathsBy: tags
Readme > https://github.com/thim81/openapi-format/tree/119-sort-path?tab=readme-ov-file#openapi-sort-paths
#121

You can play with it at the online playground https://openapi-format-playground.vercel.app/ and select on the left the desired paths ordering.

Would this solve your use-case?

I considered sorting by "operationId", but it is not required, so what would be the expected behaviour with paths without it?

[thim81]

linked to #119

[thim81]

Closing the issue.
We added option to sort by tags in release 1.22.0
If you're still experiencing problems, please feel free to reopen this issue or create a new one. Thanks for your contribution!