RicoSuter/NSwag

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

Open

#2.934 aberto em 3 de jul. de 2020

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)C# (1.189 forks)batch import
help wantedtype: bug

Métricas do repositório

Stars
 (6.291 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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!

Guia do colaborador

Direção de pesquisa
Investigue por que o nome da propriedade 'type' é filtrado do ExtensionData no NSwag. Examine a lógica de serialização para dados de extensão OpenApiOperation (provavelmente no NJsonSchema ou no núcleo do NSwag). Verifique se Newtonsoft.Json ou System.Text.Json têm um resolvedor de contrato padrão que ignora propriedades chamadas 'type'. Procure por testes ou discussões existentes no repositório sobre esse comportamento.
Pilha de tecnologia
csharp
Domain
apidocumentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C#NSwag libraryOpenAPI/Swagger
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60