OAI / OAI/OpenAPI-Specification
Structural improvements: enhance headers handling
オープン
まだ誰も着手していません。
headers
re-use: globals/defaults
- 主要言語
- Markdown
- スター
- 31.2k
- フォーク
- 9.2k
- 平均マージ
- 6時間 37分
- マージ済み PR(30日)
- 27
説明
Following (again) ideas from OAI/OpenAPI-Specification#563 and OAI/sig-moonwalk#115, extending OAI/OpenAPI-Specification#369:
- define reusable response headers (like parameters or definitions as proposed in OAI/OpenAPI-Specification#563 by @fehguy )
- set responses headers on each level: whole api, path, operation, responses (and response as stated in OAI/OpenAPI-Specification#369)
paths:
responseHeaders:
# Headers returned on all api responses
/resources:
responseHeaders:
# Headers returned on all /resources operations responses
get:
responseHeaders:
# Headers returned on all operations responses
200:
headers:
# Headers returned on this response
schemas:
responseHeaders:
# reusable headers describe with a Header Object, used with $ref
The problem is the naming consistency: responseHeaders almost everywhere vs headers on response level.
What if we use headers or responseHeaders everywhere?
nb: and don't forget to modify Header Object to include OAI/OpenAPI-Specification#321 (required)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされている OpenAPI Specification の Issue #563、#115、#369、#321 を確認し、その後、この Issue で提案されている responseHeaders と headers の配置を比較してください。仕様を変更する前に、一貫した命名と Header Object の要件を決定してください。構造上の提案と必須ヘッダーの動作が解決され、一貫して文書化されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- openapi
- 領域
- api, backend-api-design
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100