mattpolzin / mattpolzin/JSONAPI-OpenAPI
sort out test properties "skipExample" such that request & response and multiple examples are accounted for.
オープン
まだ誰も着手していません。
- 主要言語
- Swift
- スター
- 12
- フォーク
- 1
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
test properties currently just allow you to skip using the response example to validate response data or not.
- there needs to be a way to use a request example as request body or not (and validate that it matches the schema for the request).
- there needs to be a way to support multiple labeled examples instead of only supporting a single example.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず skipExample テストプロパティの処理箇所を見つけ、現在レスポンス例がどのように使用されているかを確認します。リクエスト例を独立して使用および検証できるようにし、ラベル付きのリクエスト例とレスポンス例を複数扱えるように実装します。両方向の例と複数のラベルが正しく表現されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- openapi, swift
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100