RicoSuter/NSwag

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

Aperta

#2934 aperta il 3 lug 2020

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)C# (1356 fork)batch import
help wantedtype: bug

Metriche repository

Star
 (7358 stelle)
Metriche merge PR
 (Metriche PR in attesa)

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
Investigare la serializzazione di ExtensionData in NSwag per capire perché le proprietà denominate 'type' vengono filtrate. Esaminare le impostazioni di serializzazione JSON o eventuali gestione personalizzata che potrebbe saltare parole chiave riservate come 'type' per gli oggetti OpenAPI.
Tech stack
csharp
Dominio
api
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70