RicoSuter/NSwag

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

Open

#2,934 opened on 2020年7月3日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.