swagger-api / swagger-api/swagger-parser

graceful handling of invalid item refs

Open
#237 0 comments 1 reaction 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

The following definition is not providing the proper feedback to the user and causes codegen to crash

      responses:
        200:
          description: It's working again!
          schema:
            type: array
            items:
              - $ref: '#/definitions/Kesh' 

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 crash with the YAML definition in the issue, focusing on the array item's invalid list-form $ref. Trace the parser or codegen entry point that handles this schema and make completion mean that the invalid reference produces proper user feedback without crashing.

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.