OpenAPITools / OpenAPITools/openapi-generator
[BUG] [Spring] [Java] additionalModelTypeAnnotations not applied to enums
Open
Nobody has claimed this yet.
Client: Java
Issue: Bug
Server: Spring
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator (example)?
- What's the version of OpenAPI Generator used?
- Have you search for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Bounty to sponsor the fix (example)
Description
Option additionalModelTypeAnnotations isn't applied to enums.
openapi-generator version
4.3.0
OpenAPI declaration file content or url
swagger: "2.0"
info:
title: Book
version: 1.0.0
paths:
/books:
get:
summary: Get books
responses:
200:
description: Successful response
schema:
type: array
items:
$ref: '#/definitions/Book'
definitions:
Book:
description: Book
type: object
properties:
type:
$ref: '#/definitions/BookType'
BookType:
description: Book type
type: string
enum:
- HARDCOVER
- PAPERBACK
- ELECTRONIC
Command line used for generation
generate -g spring -p additionalModelTypeAnnotations=@Foo,hideGenerationTimestamp=true
generate -g java -p additionalModelTypeAnnotations=@Foo,hideGenerationTimestamp=true
Steps to reproduce
Generate the code and see the following:
Book.java:
...
/**
* Book
*/
@ApiModel(description = "Book")
@Foo
public class Book {
...
}
BookType.java
/**
* Book type
*/
public enum BookType {
...
}
Related issues/PRs
Suggest a fix
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Spring and Java generator entry points using the supplied OpenAPI definition and the additionalModelTypeAnnotations option. Compare generated Book.java with BookType.java and verify that the enum receives the configured annotation while preserving the existing model behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100