RicoSuter/NJsonSchema

System.ObsoleteAttribute on properties

开放

#1,031 创建于 2019年7月3日

在 GitHub 查看贡献者指南
 (3 条评论) (0 个反应) (0 位负责人)C# (549 个派生)github user discovery
help wantedproject: NJsonSchema.Generationtype: bug

仓库指标

星标
 (1,581 个星标)
PR 合并指标
 (平均合并 39天 6小时) (30 天内合并 1 个 PR)

描述

We would like to prepare users of our API to a change regarding one model.

AFAICT, OpenAPI v3 added support for deprecation on property level (https://github.com/OAI/OpenAPI-Specification/issues/701, https://github.com/OAI/OpenAPI-Specification/issues/524).

As it seems, currently neither aspNetCoreToOpenApi nor openApiToCSharpClient support deprecation of a single property in a model (the generated spec / code is not affected by the attribute).

Should setting ignoreObsoleteProperties to true cause the property to be omitted from the generated spec?

贡献者指南

研究方向
研究NJsonSchema当前如何在代码生成中处理属性上的System.ObsoleteAttribute。检查ignoreObsoleteProperties标志是否影响OpenAPI规范输出中的属性级别弃用。查看aspNetCoreToOpenApi和openApiToCSharpClient的代码，看它们是否考虑属性的弃用状态。
技术栈
csharp
领域
backendapi
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
C#Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70