swagger-api / swagger-api/swagger-parser

Validation should respect $ref

Open
#982 1 comment 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

Currently, validation doesn't respect $ref.
As discussed in
https://github.com/swagger-api/swagger-parser/pull/977/files/77f69e9407890c472f5b7c0b5c2c34d484dac4e5#r246628305,
I think validation should be separated from deserialization, and should be done after deserialization(incl. ref resolve).

Once the feature is implemented, fix test case to be checked.
(https://github.com/swagger-api/swagger-parser/pull/977/files/77f69e9407890c472f5b7c0b5c2c34d484dac4e5#diff-0bb99490e9eaea062b89c98b4f1a8732)

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 reviewing the validation and deserialization flow, then inspect the test case referenced in the linked pull request 977. Determine where resolved $ref data becomes available before validation. Done means validation respects resolved references and the referenced test case passes with the corrected behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
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.