swagger-api / swagger-api/swagger-ui

duplicate $ref object in swagger UI

Open
#7,576 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

The $ref object inside schema definition is referring to json file with different name then the swagger UI displays duplicate schema definition.

For ex: "order creation response" : {
"$ref" : "#/definitions/order creation"
},

If i change it to the following then there is only one entry.
"order creation response" : {
"$ref" : "#/definitions/order creation response"
},

Swagger UI:
image
image

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

Reproduce the duplicate schema display in Swagger UI using the supplied $ref examples and compare the two screenshots. Trace the schema-definition rendering path for how differently named $ref targets are handled; done means the example renders a single schema definition without breaking valid references.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.