swagger-api / swagger-api/swagger-core

openapi 3.1.0 Schema is missing $defs information

Open
#4,469 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backlog
Dominant language
Java
Stars
7.5k
Forks
2.3k
Avg merge
18h 1m
Merged PRs (30d)
10

Description

openapi 3.1.0 Schema is missing $defs information
In this file: https://github.com/swagger-api/swagger-core/blob/master/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java

#defs information is not included from the openapi document schema
This prevents downstream users of this library from being able to implement the 3.1.0 and 2020-12 json schema $defs feature

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 modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java and inspect how schema fields from OpenAPI 3.1 documents are represented. Verify that the document's $defs information is exposed to downstream users, using an OpenAPI 3.1 example to confirm the completed behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.