microsoft / microsoft/OpenAPI.NET.OData

Add support for IsDelta in return types

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

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

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

説明

OASIS has added support for an IsDelta annotation that specifies that action or function parameters or return types may be represented as a delta (that is, they may contain deleted entities or nested changes). See https://github.com/oasis-tcs/odata-specs/blob/main/docs/odata-csdl-json/odata-csdl-json.md#annotation-coreisdelta) for a description of applying the annotation to a return type.

For example, the following "getChanges" function returns a collection of users, represented as a delta payload:

  <Function Name="getChanges" IsBound="true">
    <Parameter Name="bindingParameter" Type="microsoft.graph.savePoint" />
    <ReturnType Type="Collection(microsoft.graph.user)">
      <Annotation Term="Org.OData.Core.V1.IsDelta" Bool="true" />
    </ReturnType>
  </Function>

This Issue is to add support for this annotation to OpenAPI.NET.OData.

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

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

はじめの一歩

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

調査の方向性

この issue には実装ファイルやテストが記載されていません。まず OpenAPI.NET.OData が OData アノテーションと戻り値の型をどのように処理しているかを特定し、次に示されている関数 getChanges を入力ケースとして使用してください。生成された OpenAPI ドキュメントで、その IsDelta 戻り値型アノテーションが正しく表現されれば完了です。

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

評価

技術スタック
csharp, openapi
領域
api
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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