OAI / OAI/OpenAPI-Specification
Share header with multiple response objects
オープン
まだ誰も着手していません。
re-use: globals/defaults
- 主要言語
- Markdown
- スター
- 31.2k
- フォーク
- 9.2k
- 平均マージ
- 6時間 37分
- マージ済み PR(30日)
- 27
説明
Can there not just be a simple header generically at the response level not specific to each of the status codes? For our case, this kind of header is 99% the same across our codebase.
---
responses:
200:
description: no error
headers:
Content-Type:
description: application/json
type: string
It would be a pain to copy+paste this to each and every routine that supports HTTP JSON responses.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、OpenAPI Specification リポジトリの response object のルールを読み、個々のステータスコードの下でヘッダーが現在どのように定義されているかを比較します。response レベルで共有されるヘッダーの有効なスコープと構造を定義し、その後、機能の動作が曖昧にならないよう、関連する仕様テキストと例を更新します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- openapi
- 領域
- api
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100