swagger-api / swagger-api/swagger-parser

$ref in external file (referring the whole file) in requestBody with resolve option true

Open
#774 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

Similar to Issue #768, JSON references inside the requestBody's schema property are not properly resolved when the referring file is a whole file name.

Main OAS 3.0 file:
issue772-main.txt

Additional schema file:
issue772-reference.txt

Same issue as mentioned in #768 with only difference is $ref: "issue772-reference.yaml" (whole filename as reference)

Thanks,
Mohammed

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 comparing the attached issue772-main.txt and issue772-reference.txt files with the related behavior described in Issue #768. Reproduce parsing the requestBody schema with resolve enabled and a whole-file $ref, then verify that the external reference resolves correctly without breaking the OpenAPI document.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.