Response descriptions tend to be unhelpful
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 42/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- openapi
- 領域
- api, documentation
調査の方向性
まず、2XXレスポンスのOpenAPIレスポンス定義を見つけ、現在その説明がどのように表現されているかを確認します。必須のOpenAPI descriptionフィールドを維持しながら、汎用的な "Response" テキストに対する一貫した置き換えを決定します。対象となる成功レスポンスに有用な説明があり、APIの説明が有効なままであれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Almost all 2XX responses have the description "Response" which feels like the least possible useful description.
Now I understand that OpenAPI requires a description, which I feel is over the top when both the Path and Operation can already have one (and would usually cover at least the semantics of the "success" response). Still, I feel like this should be better as either an empty string or a note that this is a success (response)? Every response is one after all, including failures.
- 主要言語
- 言語のデータがありません
- スター
- 1.6k
- フォーク
- 342
- 平均マージ
- 2時間 23分
- マージ済み PR（30日）
- 57
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/rest-api-description のほかの issue
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
github/rest-api-description#7220 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
github/rest-api-description#7201 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
github/rest-api-description#7163 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/rest-api-description#7162 ·
-
feature
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/rest-api-description#7135 ·
github/rest-api-description の issue をすべて見る
似ている issue
-
schema_dict_to_pydantic_model TypeError on JSON Schema type arrays → extract falls back to free-text オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
browser-use/browser-use#5904 ·
-
type: enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
ynput/ayon-python-api#363 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
bug severity:low
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100