RicoSuter/NJsonSchema

System.ObsoleteAttribute on properties

Open

#1.031 geöffnet am 3. Juli 2019

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C# (550 Forks)github user discovery
help wantedproject: NJsonSchema.Generationtype: bug

Repository-Metriken

Stars
 (1.578 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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?

Contributor Guide

Research-Richtung
Untersuchen Sie, wie NJsonSchema derzeit System.ObsoleteAttribute für Eigenschaften in der Codegenerierung verarbeitet. Überprüfen Sie, ob das ignoreObsoleteProperties Flag die Veralterung auf Eigenschaftsebene in der OpenAPI Spezifikationsausgabe beeinflusst. Sehen Sie sich den Code von aspNetCoreToOpenApi und openApiToCSharpClient an, um zu sehen, ob sie die Veralterung von Eigenschaften berücksichtigen.
Tech Stack
csharp
Domain
backendapi
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70