RicoSuter/NJsonSchema

System.ObsoleteAttribute on properties

Open

#1 031 ouverte le 3 juil. 2019

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)C# (550 forks)github user discovery
help wantedproject: NJsonSchema.Generationtype: bug

Métriques du dépôt

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

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?

Guide contributeur

Direction de recherche
Recherchez comment NJsonSchema traite actuellement System.ObsoleteAttribute sur les propriétés dans la generation de code. Verifiez si le drapeau ignoreObsoleteProperties affecte la deprecation au niveau des proprietes dans la sortie de la specification OpenAPI. Examinez le code de aspNetCoreToOpenApi et openApiToCSharpClient pour voir s'ils prennent en compte l'obsolescence des proprietes.
Stack technique
csharp
Domaine
backendapi
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70