OpenAPITools / OpenAPITools/openapi-generator

[REQ] Openapi java / spring extension to generate order / position annotation for model attribute

Open
#6,992 0 comments 0 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

Hello, my request is simple. I think it already exists but i can't find it.

Does it exist a way to generate a java annotation ( custom or legacy ) which contains an information of ordering.

Example :

@Order(value = 1) or @ApiModelProperty(position = 1)
private String name;

This attribtute will just be read by java reflection.

ApiModelProperty contains position but it's not recognized by the java client or spring server open api generator.

Regards.

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

No files or tests are named. Start by locating the Java and Spring generator entry points and templates that emit model attributes, then check how ApiModelProperty and custom annotations are currently handled. Done means the requested ordering annotation is generated consistently and its output is covered for the affected generator paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
backend-api-design, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.