RicoSuter/NSwag

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

Open

#2 934 ouverte le 3 juil. 2020

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)C# (1 189 forks)batch import
help wantedtype: bug

Métriques du dépôt

Stars
 (6 291 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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!

Guide contributeur

Direction de recherche
Examinez pourquoi le nom de propriété 'type' est filtré dans ExtensionData dans NSwag. Étudiez la logique de sérialisation pour les données d'extension OpenApiOperation (probablement dans NJsonSchema ou le cœur de NSwag). Vérifiez si Newtonsoft.Json ou System.Text.Json ont un résolveur de contrat par défaut qui ignore les propriétés nommées 'type'. Recherchez des tests ou discussions existants dans le dépôt concernant ce comportement.
Stack technique
csharp
Domaine
apidocumentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#NSwag libraryOpenAPI/Swagger
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60