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