RicoSuter/NJsonSchema

System.ObsoleteAttribute on properties

Open

#1.031 aberto em 3 de jul. de 2019

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)C# (550 forks)github user discovery
help wantedproject: NJsonSchema.Generationtype: bug

Métricas do repositório

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

Description

We would like to prepare users of our API to a change regarding one model.

AFAICT, OpenAPI v3 added support for deprecation on property level (https://github.com/OAI/OpenAPI-Specification/issues/701, https://github.com/OAI/OpenAPI-Specification/issues/524).

As it seems, currently neither aspNetCoreToOpenApi nor openApiToCSharpClient support deprecation of a single property in a model (the generated spec / code is not affected by the attribute).

Should setting ignoreObsoleteProperties to true cause the property to be omitted from the generated spec?

Guia do colaborador

Direção de pesquisa
Investigue como o NJsonSchema processa atualmente o System.ObsoleteAttribute em propriedades na geração de código. Verifique se a flag ignoreObsoleteProperties afeta a depreciação em nível de propriedade na saída da especificação OpenAPI. Examine o código de aspNetCoreToOpenApi e openApiToCSharpClient para ver se eles consideram a obsolecência das propriedades.
Pilha de tecnologia
csharp
Domain
backendapi
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C#Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70