swagger-api / swagger-api/validator-badge

Validator does not validate relative references

Open
#78 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug P1
Dominant language
Java
Stars
227
Forks
81
Avg merge
2h 3m
Merged PRs (30d)
1

Description

I have a swagger file like the following. It validates correctly when the referenced yaml file (abc.yaml) is not valid.

swagger: '2.0'
info:
  version: '2.0'
  title: ABC API

consumes:
  - application/json
produces:
  - application/json
paths:
  /abc:
    $ref: 'paths/abc.yaml'

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 reproducing the shown Swagger YAML with its relative $ref to paths/abc.yaml, where the referenced YAML is invalid. Trace the validator's handling of external relative references; done means an invalid referenced file causes validation to fail rather than pass.

Written by the indexing model from the issue text.

Assessment

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