OAI / OAI/OpenAPI-Specification

Add default responses

オープン
#563 コメント 27 件 リアクション 60 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

re-use: globals/defaults
主要言語
Markdown
スター
31.2k
フォーク
9.2k
平均マージ
6時間 37分
マージ済み PR(30日)
27

説明

Currently, every single operation must declare its' own responses. This causes a whole bunch of duplication, which would be better served by having a top-level responses section in the spec. Like the security construct, operations could override the default responses on their own.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず issue の議論と、OpenAPI 仕様に既に存在するトップレベルの security 構造を確認します。トップレベルの responses セクションがどのように機能し、operation がそれをどのように上書きするかを定義します。仕様がデフォルトレスポンスと上書き動作の両方を明確に文書化できた時点を完了とします。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
openapi
領域
api
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。