OpenAPITools / OpenAPITools/openapi-generator

[BUG] [JAVA] annotation library bug when generating spring-http-interface via online generator

Open
#20,468 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
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)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

when generating spring client with library spring-http-interface via openapi-generator-online the annotationLibrary is set to swagger2.

openapi-generator version

7.11.0-SNAPSHOT / master@4259e927

OpenAPI declaration file content or url

https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml

Generation Details

using openapi-generator-online (using cli the generated code is fine!)

Steps to reproduce
curl -X POST "http://localhost:8888/api/gen/clients/spring" -H "Accept: */*" -H "Content-Type: application/json" -d "{ \"openAPIUrl\": \"https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml\",\"options\":{ \"library\": \"spring-http-interface\"}}"

generates a ZIP that has undeclared @Parameter annotations on parameters, e.g. in spring-client/src/main/java/org/openapitools/api/PetApi.java:

image

Related issues/PRs

N/A

Suggest a fix

workaround:

add "documentationProvider": "none" to options.

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

The online generator entry point is POST /api/gen/clients/spring; compare its handling of library spring-http-interface with the CLI using petstore.yaml. Reproduce the ZIP and inspect spring-client/src/main/java/org/openapitools/api/PetApi.java; done means generated parameters no longer carry undeclared @Parameter annotations without requiring documentationProvider:none.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring-boot
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.