microsoft / microsoft/OpenAPI.NET.OData

Add support for IsDelta in return types

未关闭
#592 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
C#
星标
240
派生
70
平均合并
7 小时 59 分钟
30 天内合并 PR
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. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

该 issue 没有指出任何实现文件或测试。首先定位 OpenAPI.NET.OData 如何处理 OData 注释和返回类型,然后使用所示的 getChanges 函数作为输入案例;当其 IsDelta 返回类型注释在生成的 OpenAPI 文档中得到正确表示时,即可视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp, openapi
领域
api
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。