RicoSuter/NJsonSchema

System.ObsoleteAttribute on properties

Open

#1,031 opened on Jul 3, 2019

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

Repository metrics

Stars
 (1,578 stars)
PR merge metrics
 (No merged PRs in 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?

Contributor guide

Research direction
Investigate how NJsonSchema currently processes System.ObsoleteAttribute on properties in code generation. Check if the ignoreObsoleteProperties flag affects property level deprecation in OpenAPI spec output. Look at the code for aspNetCoreToOpenApi and openApiToCSharpClient to see if they consider property obsoleteness.
Tech stack
csharp
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70