Add support for OpenAPI spec 3.2
メンテナーはふだん 9 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- java, openapi, spring-boot
調査の方向性
Start by reading how springdoc generates api-docs and handles OpenAPI specification versions, then compare its current 3.1 support with the requested 3.2 behavior. Done means springdoc can generate api-docs using version 3.2.x and represent the XML element with attributes and text content as described.
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
My problem is that I want to describe an XML schema and generate examples that have an element with attributes and a text-type child element:
<request>
<signature version="2.0">123abc</signature>
</request>
The result when translating the DAO with JAXB
@Schema
@XmlRootElement(name = "request")
public class Request {
@XmlElement(name = "signature")
public Signature signature;
public class Signature {
@Schema(example = "2.0")
@XmlElement(name = "version")
public String version;
@Schema(example = "123abc")
@XmlValue
public String value;
}
but rendering it with springdoc 2.8.17 and OpenAPI 3.1 gives me the api-docs:
<request>
<signature version="2.0">
<value>123abc</value>
</signature>
</request>
Describe the solution you'd like
The lack of support for this stems from OpenAPI not supporting this as of spec 3.1. There was an issue filed for OpenAPI-Specification https://github.com/OAI/OpenAPI-Specification/issues/630. It was implemented in https://github.com/OAI/OpenAPI-Specification/pull/4592 and released in https://github.com/OAI/OpenAPI-Specification/releases/tag/3.2.0.
So I'd like springdoc to add support for api-docs version 3.2.x.
Describe alternatives you've considered
My alternative for now is to hard-code the example into my api-docs and accept the wrong looking schema until newer OpenAPI spec versions.
- 主要言語
- Java
- スター
- 3.7k
- フォーク
- 605
- 平均マージ
- 9日 11時間
- マージ済み PR（30日）
- 14
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
springdoc/springdoc-openapi のほかの issue
-
enhancement upstream
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
springdoc/springdoc-openapi#3309 · コメント 4 件 · リアクション 1 件 ·
メンテナーはふだん 9 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
springdoc/springdoc-openapi#3404 · コメント 1 件 ·
メンテナーはふだん 9 日以内に返信
springdoc/springdoc-openapi の issue をすべて見る
似ている issue
-
API `/api/dataverses/{identifier}/dataset/linkingDataverses?alreadyLinking=true` returns at most 1 collection対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンType: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
javaoperatorsdk.client.oauth-token has no effect on the Kubernetes client対応中かも @RaphaelFakhri が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
MCP add-on: JSON responses with non-ASCII characters are truncated (wrong Content-Length)対応中かも @dhanushbs10 が今日担当しました。 オープンadd-on bug in:mcp
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
Map.Coordinate does not implement proper equals対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンvaadin-map
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
vaadin/flow-components#10586 ·
メンテナーはふだん 1 日以内に返信
-
WeReadInstaller writes the launcher database on the main thread at handover (Activity pause timeout)オープンbug good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100