RicoSuter/NSwag

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

Open

#2.934 geöffnet am 3. Juli 2020

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)C# (1.189 Forks)batch import
help wantedtype: bug

Repository-Metriken

Stars
 (6.291 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuche, warum der Eigenschaftsname 'type' in NSwag aus ExtensionData herausgefiltert wird. Untersuche die Serialisierungslogik für OpenApiOperation Erweiterungsdaten (wahrscheinlich in NJsonSchema oder NSwag Core). Prüfe, ob Newtonsoft.Json oder System.Text.Json einen standardmäßigen Contract Resolver haben, der Eigenschaften mit dem Namen 'type' ignoriert. Suche nach vorhandenen Tests oder Diskussionen im Repository zu diesem Verhalten.
Tech Stack
csharp
Domain
apidocumentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#NSwag libraryOpenAPI/Swagger
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60