RicoSuter/NSwag

ExtensionData for Operations won't allow objects with properties named "type"

Open

#2,934 创建于 2020年7月3日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)C# (6,291 star) (1,189 fork)batch import
help wantedtype: bug

描述

Hi, I'm using NSwag to generate swagger definition file and using custom IOperationProcessor implementation to add new node at operation's level.

The below code(part of IOperationProcessor.Process method) won't add type property to the result schema, all other fields are added fine, if I use TYPE it is also included, but type seems like is filtered out/ignored.

context.OperationDescription.Operation.ExtensionData[Key] = new
{
     type="any value",
     otherNormalField="other value",
     ...
};

I would assume that extension data has to support any property names - is that correct?

Please advise!

贡献者指南

技术栈
csharp
领域
apidocumentation
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
C#NSwag libraryOpenAPI/Swagger
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
Investigate why the property name 'type' is filtered out from ExtensionData in NSwag. Examine the serialization logic for OpenApiOperation extension data (likely in NJsonSchema or NSwag core). Check if Newtonsoft.Json or System.Text.Json has a default contract resolver that ignores properties named 'type'. Look for existing tests or discussions in the repository about this behavior.
ExtensionData for Operations won't allow objects with properties named "type" · RicoSuter/NSwag#2934 | Good First Issue