swagger-api / swagger-api/swagger-parser

reference resolution fails in openapi-diff for schema reference for array items

Open
#1,889 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
867
Forks
560
Avg merge
2d 21h
Merged PRs (30d)
7

Description

Reference resolution fails. Seems to be caused by using the same name in both openapi.yaml components/schemas and the filename of the referenced schema file.

Please see details and example in https://github.com/OpenAPITools/openapi-diff/issues/464

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 details and example in openapi-diff issue 464, then reproduce the failure involving an array item's schema reference when a component schema and referenced schema file share a name. Done means reference resolution succeeds for that case without the naming collision causing failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.