OpenAPITools / OpenAPITools/openapi-generator

[BUG] [openapi json]: requestBody contains $ref and content at the same time

Open
#11,275 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

Json generator can generate both "$ref" param and "content" param.
Screenshot 2022-01-11 at 12 11 30

Config is still valid, but IDEA marks as warning such params. Also swagger-ui couldn't work correctly with such config: https://github.com/springfox/springfox/issues/3956

openapi-generator version

3.5.1 and on latest image on docker is still reproduced

Steps to reproduce

I created minimal demo to reproduce: https://github.com/SButterfly/openapi_json_bug

Expected behavior

I expected only one of "$ref" or "content" to remain.

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 with the minimal reproduction in https://github.com/SButterfly/openapi_json_bug and inspect the generated OpenAPI JSON for requestBody entries. Trace that output into the OpenAPI Generator request-body generation entry point, then run the reproduction to verify that each requestBody contains only one of "$ref" or "content".

Written by the indexing model from the issue text.

Assessment

Tech stack
java, json
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.