RicoSuter/NSwag

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

Open

#2934 aperta il 3 lug 2020

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)C# (1189 fork)batch import
help wantedtype: bug

Metriche repository

Star
 (6291 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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!

Guida contributor

Direzione di ricerca
Indaga sul motivo per cui il nome della proprietà 'type' viene filtrato da ExtensionData in NSwag. Esamina la logica di serializzazione per i dati di estensione OpenApiOperation (probabilmente in NJsonSchema o nel core di NSwag). Controlla se Newtonsoft.Json o System.Text.Json hanno un contract resolver predefinito che ignora le proprietà denominate 'type'. Cerca test o discussioni esistenti nel repository riguardo a questo comportamento.
Tech stack
csharp
Dominio
apidocumentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#NSwag libraryOpenAPI/Swagger
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60