OpenAPITools / OpenAPITools/openapi-generator

[REQ] Allow sorting Parameters by occurence in spec

Open
#9,877 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

There are some ways to influence the parameter order. Unfortunately the (legacy?) order of defaulting to the order in the OpenAPI manifest is not among them.

Describe the solution you'd like

I'd propose a parameter to specify preserveParameterOrder: true, defaulting to false, mutually exclusive to prependFormOrBodyParameters: true that does not reorder allParams.

Describe alternatives you've considered

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the generator code that orders allParams and handles prependFormOrBodyParameters. Add the proposed preserveParameterOrder option with its mutual exclusion rule, preserving manifest order when enabled, and verify that the default behavior remains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.