Produce deprecated property in JsonSchema for obsolete types by Youssef1313 · Pull Request #130665 · dotnet/runtime

Youssef1313 · 2026-07-14T06:41:15Z

Spec: https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-01#section-9.3

Copilot

Pull request overview

This PR updates the System.Text.Json JSON Schema exporter to emit the JSON Schema deprecated keyword when exporting schemas for [Obsolete] .NET types, and adds a regression test covering the new behavior.

Changes:

Detect [Obsolete] on exported types and set deprecated: true in the generated schema.
Add Deprecated support to the internal JsonSchema model and include it in JSON output.
Add a unit test validating deprecated is emitted for an obsolete type.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs	Adds a test case validating `deprecated` is produced for an `[Obsolete]` type.
src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporter.cs	Marks exported schemas as deprecated when the associated .NET type has `[Obsolete]`.
src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchema.cs	Adds a `Deprecated` keyword to the schema model, counts it, and emits it during JSON serialization.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

dotnet-policy-service · 2026-07-14T06:54:30Z

Tagging subscribers to this area: @dotnet/area-system-text-json
See info in area-owners.md if you want to be subscribed.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

eiriktsarpalis · 2026-07-14T08:17:01Z

        public int? MaxLength { get => _maxLength; set { VerifyMutable(); _maxLength = value; } }
        private int? _maxLength;

+        public bool Deprecated { get => _deprecated; set { VerifyMutable(); _deprecated = value; } }


Other keywords model both all possible values plus the absense of a value. Correspondingly, this should be bool? and we should include it in the generated schema document if non-null.

I'd argue it should only be serialized when explicitly set to true, and ignored otherwise, based on the keyword definition

Omitting this keyword has the same behavior as a value of false.

It's an internal model. So we could make it nullable bool, but I think we will never set it to false. So it will either be true (serialized with value true) or will be null (not serialized at all).

This will be behaviourly identical to what I have now with it being a bool that's only serialized when true.

I don't disagree, but that should be the decision of the mapping layer. The model itself should be neutral in representing all possible states.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.


+        private static bool HasObsoleteAttribute(ICustomAttributeProvider? attributeProvider)
+        {
+            if (attributeProvider is null)
+            {
+                return false;
+            }
+
+            // Identify ObsoleteAttribute using its full type name rather than typeof(ObsoleteAttribute).
+            // On downlevel targets System.Text.Json compiles in an internal ObsoleteAttribute polyfill
+            // that would otherwise shadow the framework type, causing the typeof comparison to never match
+            // the ObsoleteAttribute applied by user code.
+            foreach (object attribute in attributeProvider.GetCustomAttributes(inherit: true))
+            {
+                if (attribute.GetType().FullName == "System.ObsoleteAttribute")
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }


eiriktsarpalis · 2026-07-14T13:35:42Z

+            AssertDeprecated(properties["MyString"], expectedDeprecated: false);
+
+            // Property annotated with [Obsolete] reports deprecated.
+            AssertDeprecated(properties["MyObsoleteString"], expectedDeprecated: true);


I would recommend having the test asserting the exact shape of the generated schema, rather than interrogating individual aspects of it. There's a built-in theory you can use to drive this comparison.

eiriktsarpalis · 2026-07-14T13:36:47Z


            JsonSchema CompleteSchema(ref GenerationState state, JsonSchema schema)
            {
+                if (HasObsoleteAttribute(typeInfo.Type) ||


If the type itself is marked obsolete, wouldn't this result in every single contained property also being marked obsolete?

Copilot AI review requested due to automatic review settings July 14, 2026 06:41

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:41 — with GitHub Actions Inactive

github-actions Bot added the area-System.Text.Json label Jul 14, 2026

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:41 — with GitHub Actions Inactive

Copilot started reviewing on behalf of Youssef1313 July 14, 2026 06:41 View session

Youssef1313 had a problem deploying to copilot-pat-pool July 14, 2026 06:42 — with GitHub Actions Failure

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:43 — with GitHub Actions Inactive

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:44 — with GitHub Actions Inactive

Copilot AI reviewed Jul 14, 2026

View reviewed changes

Comment thread src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporter.cs

Comment thread src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs

Comment thread src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs

Copilot AI review requested due to automatic review settings July 14, 2026 06:50

Youssef1313 force-pushed the dev/ygerges/deprecated-schema branch from 2e895bf to a5d6c2d Compare July 14, 2026 06:50

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:50 — with GitHub Actions Inactive

Copilot started reviewing on behalf of Youssef1313 July 14, 2026 06:50 View session

Youssef1313 force-pushed the dev/ygerges/deprecated-schema branch from a5d6c2d to 0460d8b Compare July 14, 2026 06:51

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:51 — with GitHub Actions Inactive

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:52 — with GitHub Actions Inactive

Youssef1313 had a problem deploying to copilot-pat-pool July 14, 2026 06:53 — with GitHub Actions Failure

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:54 — with GitHub Actions Inactive

Copilot AI reviewed Jul 14, 2026

View reviewed changes

Comment thread src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporter.cs Outdated

Comment thread src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs Outdated

Comment thread src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs

Copilot AI review requested due to automatic review settings July 14, 2026 06:54

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:54 — with GitHub Actions Inactive

Copilot started reviewing on behalf of Youssef1313 July 14, 2026 06:54 View session

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 06:54 — with GitHub Actions Inactive

Copilot AI reviewed Jul 14, 2026

View reviewed changes

Comment thread src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporter.cs Outdated

Comment thread src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs

Copilot AI review requested due to automatic review settings July 14, 2026 07:01

Youssef1313 force-pushed the dev/ygerges/deprecated-schema branch from 0460d8b to 76a2de7 Compare July 14, 2026 07:01

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 07:01 — with GitHub Actions Inactive

Copilot AI reviewed Jul 14, 2026

View reviewed changes

Comment thread src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporter.cs Outdated

Produce deprecated property in JsonSchema for obsolete types

3c313d5

Copilot AI review requested due to automatic review settings July 14, 2026 07:42

Youssef1313 force-pushed the dev/ygerges/deprecated-schema branch from 76a2de7 to 3c313d5 Compare July 14, 2026 07:42

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 07:42 — with GitHub Actions Inactive

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 07:43 — with GitHub Actions Inactive

Copilot started reviewing on behalf of Youssef1313 July 14, 2026 07:43 View session

Youssef1313 had a problem deploying to copilot-pat-pool July 14, 2026 07:44 — with GitHub Actions Failure

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 07:44 — with GitHub Actions Inactive

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 07:45 — with GitHub Actions Inactive

Copilot AI reviewed Jul 14, 2026

View reviewed changes

Comment thread src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs

Comment thread src/libraries/System.Text.Json/src/System/Text/Json/Schema/JsonSchemaExporter.cs Outdated

eiriktsarpalis reviewed Jul 14, 2026

View reviewed changes

Comment thread src/libraries/System.Text.Json/tests/Common/JsonSchemaExporterTests.cs

Address review comments

a1e1d38

This was referenced Jul 14, 2026

slow macOS - "##[error]The job running on agent Azure Pipelines 9 ran longer than the maximum time of 60 minutes." dotnet/dnceng#1883

Open

The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#3008

Open

Handle properties, add tests

a668165

Copilot AI review requested due to automatic review settings July 14, 2026 13:17

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 13:17 — with GitHub Actions Inactive

Copilot started reviewing on behalf of Youssef1313 July 14, 2026 13:17 View session

Youssef1313 had a problem deploying to copilot-pat-pool July 14, 2026 13:18 — with GitHub Actions Failure

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 13:19 — with GitHub Actions Inactive

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 13:20 — with GitHub Actions Inactive

Youssef1313 requested a review from eiriktsarpalis July 14, 2026 13:20

Youssef1313 temporarily deployed to copilot-pat-pool July 14, 2026 13:21 — with GitHub Actions Inactive

Copilot AI reviewed Jul 14, 2026

View reviewed changes

eiriktsarpalis reviewed Jul 14, 2026

View reviewed changes

Uh oh!

Conversation

Youssef1313 commented Jul 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dotnet-policy-service Bot commented Jul 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

eiriktsarpalis Jul 14, 2026

Choose a reason for hiding this comment

Uh oh!

baywet Jul 14, 2026

Choose a reason for hiding this comment

Uh oh!

Youssef1313 Jul 14, 2026

Choose a reason for hiding this comment

Uh oh!

eiriktsarpalis Jul 14, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

eiriktsarpalis Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eiriktsarpalis Jul 14, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

eiriktsarpalis Jul 14, 2026 •

edited

Loading