microsoft / microsoft/OpenAPI.NET.OData

add dynamicRef/generic support for collections when openapi 3.1 is supported

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

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

blocked type:enhancement
主要言語
C#
スター
240
フォーク
70
平均マージ
7時間 59分
マージ済み PR(30日)
13

説明

today we implement collections as:

  • BaseCollectionResponse (Odata next link field, etc...)
  • BaseCounCollectionResponse (inherits from the previous, add the count field)
  • A lot of Users/Groups/Sites/...Collection response (inherits from one of the previous, adds the value property)

With the advent of OpenAPI 3.1 support we could get rid of all the UsersCollectionResponse schemas (about 4k in v1) and make the base types generic.

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

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

はじめの一歩

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

調査の方向性

まず、collection のレスポンススキーマ生成と、repository の OpenAPI 3.1 対応を確認します。汎用的な collection 基底型と dynamicRef の動作を定義し、その後、生成されたドキュメントで多数のリソース固有の collection スキーマが不要になっていることを確認します。

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

評価

技術スタック
csharp
領域
api
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

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

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