RicoSuter/NSwag

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

Open

#2934 opened on Jul 3, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedtype: bug

Description

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!

Contributor guide

Tech stack
csharp
Domain
apidocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C#NSwag libraryOpenAPI/Swagger
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.