OpenAPITools / OpenAPITools/openapi-generator

[BUG] Spring generator: Incorrect import if spec contains a schema named schema

Open
#16,584 2 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

Incorrect import statement when the specfile contains a schema object inside schemas.

Schemas: Schema: allOf: - $ref: '#/components/schemas/Resource' title: Schema properties: id: type: string readOnly: true name: type: string readOnly: true description: type: string readOnly: true attributes: type: array items: $ref: '#/components/schemas/Attribute' readOnly: true

Result:

`
import io.swagger.v3.oas.annotations.media.Schema;

@ResponseStatus(HttpStatus.OK)
Schema getSchema(
@PathVariable("id") String id
);`

Incorrect import default to io.swagger.v3.oas.annotations.media.Schema

openapi-generator version

Version: 7.0.0

OpenAPI declaration file content or url

https://gist.github.com/GianniGiglio/f296bd2e720708a7cb24513b14e6703e

Generation Details

Generator: spring
Library: spring-boot, spring-cloud

Steps to reproduce

Generate using specfile

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 reproducing the Spring generator output with the OpenAPI declaration in the linked gist, focusing on the schema named Schema and the generated method shown in the report. Trace how the generator chooses imports for that model, and consider the issue done when the generated code imports the model rather than io.swagger.v3.oas.annotations.media.Schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring, spring-boot
Domain
api, backend
Issue type
Bug
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.