fix: Enum descriptions serialization/property (#1861)

RicoSuter · web-flow · commit 58a90b9ca7ba · 2025-09-25T22:14:43.000+01:00
diff --git a/src/NJsonSchema/Generation/JsonSchemaGenerator.cs b/src/NJsonSchema/Generation/JsonSchemaGenerator.cs
@@ -702,16 +702,17 @@ protected virtual void GenerateEnum(JsonSchema schema, JsonTypeDescription typeD
             schema.EnumerationDescriptions.Clear();
             schema.IsFlagEnumerable = contextualType.IsAttributeDefined<FlagsAttribute>(true);
 
-            var allDescriptionsEmpty = true;
             Func<object, string?>? enumValueConverter = null;
+
+            var allDescriptionsEmpty = true;
             var underlyingType = Enum.GetUnderlyingType(contextualType.Type);
             foreach (var enumName in Enum.GetNames(contextualType.Type))
             {
-                string? enumDescription = null;
                 var field = contextualType.Type.GetRuntimeField(enumName);
+
                 // Retrieve the Description attribute value, if present.
+                string? enumDescription = null;
                 var descriptionAttribute = field?.GetCustomAttribute<DescriptionAttribute>();
-
                 if (descriptionAttribute != null)
                 {
                     enumDescription = descriptionAttribute.Description;
@@ -785,7 +786,7 @@ private void ApplyAdditionalProperties<TSchemaType>(TSchemaType schema, Type typ
         {
             var extensionDataProperty = type.GetContextualProperties()
                 .FirstOrDefault(p => p.GetAttributes(true).Any(a =>
-                    Namotion.Reflection.TypeExtensions.IsAssignableToTypeName(a.GetType(), "JsonExtensionDataAttribute", TypeNameStyle.Name)));
+                    a.GetType().IsAssignableToTypeName("JsonExtensionDataAttribute", TypeNameStyle.Name)));
 
             if (extensionDataProperty != null)
             {
diff --git a/src/NJsonSchema/JsonSchema.Serialization.cs b/src/NJsonSchema/JsonSchema.Serialization.cs
@@ -125,9 +125,9 @@ internal object? DiscriminatorRaw
             }
             set
             {
-                if (value is string)
+                if (value is string stringValue)
                 {
-                    Discriminator = (string) value;
+                    Discriminator = stringValue;
                 }
                 else if (value != null)
                 {
@@ -151,9 +151,9 @@ internal object? ExclusiveMaximumRaw
             get => ExclusiveMaximum ?? (IsExclusiveMaximum ? (object) true : null);
             set
             {
-                if (value is bool)
+                if (value is bool boolValue)
                 {
-                    IsExclusiveMaximum = (bool) value;
+                    IsExclusiveMaximum = boolValue;
                 }
                 else if (value != null && (value.Equals("true") || value.Equals("false")))
                 {
@@ -173,9 +173,9 @@ internal object? ExclusiveMinimumRaw
             get => ExclusiveMinimum ?? (IsExclusiveMinimum ? (object) true : null);
             set
             {
-                if (value is bool)
+                if (value is bool boolValue)
                 {
-                    IsExclusiveMinimum = (bool) value;
+                    IsExclusiveMinimum = boolValue;
                 }
                 else if (value != null && (value.Equals("true") || value.Equals("false")))
                 {
@@ -207,9 +207,9 @@ internal object? AdditionalItemsRaw
             }
             set
             {
-                if (value is bool)
+                if (value is bool boolValue)
                 {
-                    AllowAdditionalItems = (bool) value;
+                    AllowAdditionalItems = boolValue;
                 }
                 else if (value != null && (value.Equals("true") || value.Equals("false")))
                 {
@@ -261,9 +261,9 @@ internal object? AdditionalPropertiesRaw
             }
             set
             {
-                if (value is bool)
+                if (value is bool boolValue)
                 {
-                    AllowAdditionalProperties = (bool) value;
+                    AllowAdditionalProperties = boolValue;
                 }
                 else if (value != null && (value.Equals("true") || value.Equals("false")))
                 {
@@ -295,9 +295,9 @@ internal object? ItemsRaw
             }
             set
             {
-                if (value is JArray)
+                if (value is JArray array)
                 {
-                    Items = new ObservableCollection<JsonSchema>(((JArray) value).Select(FromJsonWithCurrentSettings));
+                    Items = new ObservableCollection<JsonSchema>(array.Select(FromJsonWithCurrentSettings));
                 }
                 else if (value != null)
                 {
@@ -350,14 +350,14 @@ private void ResetTypeRaw()
         [JsonProperty("required", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal ICollection<string>? RequiredPropertiesRaw
         {
-            get => RequiredProperties != null && RequiredProperties.Count > 0 ? RequiredProperties : null;
+            get => RequiredProperties is { Count: > 0 } ? RequiredProperties : null;
             set => RequiredProperties = value ?? [];
         }
 
         [JsonProperty("properties", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal IDictionary<string, JsonSchemaProperty>? PropertiesRaw
         {
-            get => _properties != null && _properties.Count > 0 ? Properties : null;
+            get => _properties is { Count: > 0 } ? Properties : null;
             set => Properties = value != null ? new ObservableDictionary<string, JsonSchemaProperty>(value!) : [];
         }
 
@@ -373,7 +373,7 @@ internal IDictionary<string, JsonSchemaProperty>? PatternPropertiesRaw
         [JsonProperty("definitions", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal IDictionary<string, JsonSchema>? DefinitionsRaw
         {
-            get => Definitions != null && Definitions.Count > 0 ? Definitions : null;
+            get => Definitions is { Count: > 0 } ? Definitions : null;
             set => Definitions = value != null ? new ObservableDictionary<string, JsonSchema>(value!) : [];
         }
 
@@ -409,7 +409,7 @@ internal Collection<string>? EnumerationVarNamesRaw
         [JsonProperty("x-enumNames", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal Collection<string>? EnumerationNamesRaw
         {
-            get => EnumerationNames != null && EnumerationNames.Count > 0 ? EnumerationNames : null;
+            get => EnumerationNames is { Count: > 0 } ? EnumerationNames : null;
             set => EnumerationNames = value != null ? new ObservableCollection<string>(value) : [];
         }
 
@@ -421,7 +421,7 @@ internal JArray? EnumerationDescriptionsRaw
             set => EnumerationDescriptionsDashedRaw = value;
         }
 
-        /// <summary>Gets or sets the enumeration descriptions (optional, draft v5). </summary>
+        /// <summary>Gets or sets the enumeration descriptions (optional, draft v5).</summary>
         [JsonProperty("x-enum-descriptions", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal JArray? EnumerationDescriptionsDashedRaw
         {
@@ -439,28 +439,28 @@ internal JArray? EnumerationDescriptionsDashedRaw
         [JsonProperty("enum", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal ICollection<object?>? EnumerationRaw
         {
-            get => Enumeration != null && Enumeration.Count > 0 ? Enumeration : null;
+            get => Enumeration is { Count: > 0 } ? Enumeration : null;
             set => Enumeration = value != null ? new ObservableCollection<object?>(value) : [];
         }
 
         [JsonProperty("allOf", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal ICollection<JsonSchema>? AllOfRaw
         {
-            get => _allOf != null && _allOf.Count > 0 ? AllOf : null;
+            get => _allOf is { Count: > 0 } ? AllOf : null;
             set => AllOf = value != null ? new ObservableCollection<JsonSchema>(value) : [];
         }
 
         [JsonProperty("anyOf", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal ICollection<JsonSchema>? AnyOfRaw
         {
-            get => _anyOf != null && _anyOf.Count > 0 ? AnyOf : null;
+            get => _anyOf is { Count: > 0 } ? AnyOf : null;
             set => AnyOf = value != null ? new ObservableCollection<JsonSchema>(value) : [];
         }
 
         [JsonProperty("oneOf", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         internal ICollection<JsonSchema>? OneOfRaw
         {
-            get => _oneOf != null && _oneOf.Count > 0 ? OneOf : null;
+            get => _oneOf is { Count: > 0 } ? OneOf : null;
             set => OneOf = value != null ? new ObservableCollection<JsonSchema>(value) : [];
         }
 
@@ -542,9 +542,8 @@ private void InitializeSchemaCollection(object? sender, NotifyCollectionChangedE
 
                 if (keysToRemove != null)
                 {
-                    for (var i = 0; i < keysToRemove.Count; i++)
+                    foreach (var key in keysToRemove)
                     {
-                        var key = keysToRemove[i];
                         collection.Remove(key);
                     }
                 }
@@ -553,32 +552,23 @@ private void InitializeSchemaCollection(object? sender, NotifyCollectionChangedE
 
         private static List<string?>? ConvertPossibleStringArray(JArray? array)
         {
-            if (array is null || array.Count == 0)
-            {
-                return null;
-            }
-
-            if (array.Count > 0)
+            if (array?.Count > 0)
             {
                 var result = new List<string?>(array.Count);
-                for (var i = 0; i < array.Count; i++)
+                foreach (var item in array)
                 {
-                    var item = array[i];
-                    if (item.Type is JTokenType.String)
+                    switch (item.Type)
                     {
-                        result.Add(null);
-                    }
-                    else if (item.Type is JTokenType.Null)
-                    {
-                        result.Add(null);
-                    }
-                    else
-                    {
-                        // we stop processing as we don't to trust the content
-                        return null;
+                        case JTokenType.String:
+                            result.Add(item.Value<string>());
+                            break;
+                        case JTokenType.Null:
+                            result.Add(null);
+                            break;
+                        default:
+                            return null; // unsupported token type, abort
                     }
                 }
-
                 return result;
             }
 

Original file line number	Diff line number	Diff line change
`@@ -125,9 +125,9 @@ internal object? DiscriminatorRaw`
`125`	`125`	`}`
`126`	`126`	`set`
`127`	`127`	`{`
`128`		`- if (value is string)`
	`128`	`+ if (value is string stringValue)`
`129`	`129`	`{`
`130`		`- Discriminator = (string) value;`
	`130`	`+ Discriminator = stringValue;`
`131`	`131`	`}`
`132`	`132`	`else if (value != null)`
`133`	`133`	`{`
`@@ -151,9 +151,9 @@ internal object? ExclusiveMaximumRaw`
`151`	`151`	`get => ExclusiveMaximum ?? (IsExclusiveMaximum ? (object) true : null);`
`152`	`152`	`set`
`153`	`153`	`{`
`154`		`- if (value is bool)`
	`154`	`+ if (value is bool boolValue)`
`155`	`155`	`{`
`156`		`- IsExclusiveMaximum = (bool) value;`
	`156`	`+ IsExclusiveMaximum = boolValue;`
`157`	`157`	`}`
`158`	`158`	`else if (value != null && (value.Equals("true") \|\| value.Equals("false")))`
`159`	`159`	`{`
`@@ -173,9 +173,9 @@ internal object? ExclusiveMinimumRaw`
`173`	`173`	`get => ExclusiveMinimum ?? (IsExclusiveMinimum ? (object) true : null);`
`174`	`174`	`set`
`175`	`175`	`{`
`176`		`- if (value is bool)`
	`176`	`+ if (value is bool boolValue)`
`177`	`177`	`{`
`178`		`- IsExclusiveMinimum = (bool) value;`
	`178`	`+ IsExclusiveMinimum = boolValue;`
`179`	`179`	`}`
`180`	`180`	`else if (value != null && (value.Equals("true") \|\| value.Equals("false")))`
`181`	`181`	`{`
`@@ -207,9 +207,9 @@ internal object? AdditionalItemsRaw`
`207`	`207`	`}`
`208`	`208`	`set`
`209`	`209`	`{`
`210`		`- if (value is bool)`
	`210`	`+ if (value is bool boolValue)`
`211`	`211`	`{`
`212`		`- AllowAdditionalItems = (bool) value;`
	`212`	`+ AllowAdditionalItems = boolValue;`
`213`	`213`	`}`
`214`	`214`	`else if (value != null && (value.Equals("true") \|\| value.Equals("false")))`
`215`	`215`	`{`
`@@ -261,9 +261,9 @@ internal object? AdditionalPropertiesRaw`
`261`	`261`	`}`
`262`	`262`	`set`
`263`	`263`	`{`
`264`		`- if (value is bool)`
	`264`	`+ if (value is bool boolValue)`
`265`	`265`	`{`
`266`		`- AllowAdditionalProperties = (bool) value;`
	`266`	`+ AllowAdditionalProperties = boolValue;`
`267`	`267`	`}`
`268`	`268`	`else if (value != null && (value.Equals("true") \|\| value.Equals("false")))`
`269`	`269`	`{`
`@@ -295,9 +295,9 @@ internal object? ItemsRaw`
`295`	`295`	`}`
`296`	`296`	`set`
`297`	`297`	`{`
`298`		`- if (value is JArray)`
	`298`	`+ if (value is JArray array)`
`299`	`299`	`{`
`300`		`- Items = new ObservableCollection<JsonSchema>(((JArray) value).Select(FromJsonWithCurrentSettings));`
	`300`	`+ Items = new ObservableCollection<JsonSchema>(array.Select(FromJsonWithCurrentSettings));`
`301`	`301`	`}`
`302`	`302`	`else if (value != null)`
`303`	`303`	`{`
`@@ -350,14 +350,14 @@ private void ResetTypeRaw()`
`350`	`350`	`[JsonProperty("required", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`351`	`351`	`internal ICollection<string>? RequiredPropertiesRaw`
`352`	`352`	`{`
`353`		`- get => RequiredProperties != null && RequiredProperties.Count > 0 ? RequiredProperties : null;`
	`353`	`+ get => RequiredProperties is { Count: > 0 } ? RequiredProperties : null;`
`354`	`354`	`set => RequiredProperties = value ?? [];`
`355`	`355`	`}`
`356`	`356`
`357`	`357`	`[JsonProperty("properties", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`358`	`358`	`internal IDictionary<string, JsonSchemaProperty>? PropertiesRaw`
`359`	`359`	`{`
`360`		`- get => _properties != null && _properties.Count > 0 ? Properties : null;`
	`360`	`+ get => _properties is { Count: > 0 } ? Properties : null;`
`361`	`361`	`set => Properties = value != null ? new ObservableDictionary<string, JsonSchemaProperty>(value!) : [];`
`362`	`362`	`}`
`363`	`363`
`@@ -373,7 +373,7 @@ internal IDictionary<string, JsonSchemaProperty>? PatternPropertiesRaw`
`373`	`373`	`[JsonProperty("definitions", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`374`	`374`	`internal IDictionary<string, JsonSchema>? DefinitionsRaw`
`375`	`375`	`{`
`376`		`- get => Definitions != null && Definitions.Count > 0 ? Definitions : null;`
	`376`	`+ get => Definitions is { Count: > 0 } ? Definitions : null;`
`377`	`377`	`set => Definitions = value != null ? new ObservableDictionary<string, JsonSchema>(value!) : [];`
`378`	`378`	`}`
`379`	`379`
`@@ -409,7 +409,7 @@ internal Collection<string>? EnumerationVarNamesRaw`
`409`	`409`	`[JsonProperty("x-enumNames", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`410`	`410`	`internal Collection<string>? EnumerationNamesRaw`
`411`	`411`	`{`
`412`		`- get => EnumerationNames != null && EnumerationNames.Count > 0 ? EnumerationNames : null;`
	`412`	`+ get => EnumerationNames is { Count: > 0 } ? EnumerationNames : null;`
`413`	`413`	`set => EnumerationNames = value != null ? new ObservableCollection<string>(value) : [];`
`414`	`414`	`}`
`415`	`415`
`@@ -421,7 +421,7 @@ internal JArray? EnumerationDescriptionsRaw`
`421`	`421`	`set => EnumerationDescriptionsDashedRaw = value;`
`422`	`422`	`}`
`423`	`423`
`424`		`- /// <summary>Gets or sets the enumeration descriptions (optional, draft v5). </summary>`
	`424`	`+ /// <summary>Gets or sets the enumeration descriptions (optional, draft v5).</summary>`
`425`	`425`	`[JsonProperty("x-enum-descriptions", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`426`	`426`	`internal JArray? EnumerationDescriptionsDashedRaw`
`427`	`427`	`{`
`@@ -439,28 +439,28 @@ internal JArray? EnumerationDescriptionsDashedRaw`
`439`	`439`	`[JsonProperty("enum", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`440`	`440`	`internal ICollection<object?>? EnumerationRaw`
`441`	`441`	`{`
`442`		`- get => Enumeration != null && Enumeration.Count > 0 ? Enumeration : null;`
	`442`	`+ get => Enumeration is { Count: > 0 } ? Enumeration : null;`
`443`	`443`	`set => Enumeration = value != null ? new ObservableCollection<object?>(value) : [];`
`444`	`444`	`}`
`445`	`445`
`446`	`446`	`[JsonProperty("allOf", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`447`	`447`	`internal ICollection<JsonSchema>? AllOfRaw`
`448`	`448`	`{`
`449`		`- get => _allOf != null && _allOf.Count > 0 ? AllOf : null;`
	`449`	`+ get => _allOf is { Count: > 0 } ? AllOf : null;`
`450`	`450`	`set => AllOf = value != null ? new ObservableCollection<JsonSchema>(value) : [];`
`451`	`451`	`}`
`452`	`452`
`453`	`453`	`[JsonProperty("anyOf", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`454`	`454`	`internal ICollection<JsonSchema>? AnyOfRaw`
`455`	`455`	`{`
`456`		`- get => _anyOf != null && _anyOf.Count > 0 ? AnyOf : null;`
	`456`	`+ get => _anyOf is { Count: > 0 } ? AnyOf : null;`
`457`	`457`	`set => AnyOf = value != null ? new ObservableCollection<JsonSchema>(value) : [];`
`458`	`458`	`}`
`459`	`459`
`460`	`460`	`[JsonProperty("oneOf", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]`
`461`	`461`	`internal ICollection<JsonSchema>? OneOfRaw`
`462`	`462`	`{`
`463`		`- get => _oneOf != null && _oneOf.Count > 0 ? OneOf : null;`
	`463`	`+ get => _oneOf is { Count: > 0 } ? OneOf : null;`
`464`	`464`	`set => OneOf = value != null ? new ObservableCollection<JsonSchema>(value) : [];`
`465`	`465`	`}`
`466`	`466`
`@@ -542,9 +542,8 @@ private void InitializeSchemaCollection(object? sender, NotifyCollectionChangedE`
`542`	`542`
`543`	`543`	`if (keysToRemove != null)`
`544`	`544`	`{`
`545`		`- for (var i = 0; i < keysToRemove.Count; i++)`
	`545`	`+ foreach (var key in keysToRemove)`
`546`	`546`	`{`
`547`		`- var key = keysToRemove[i];`
`548`	`547`	`collection.Remove(key);`
`549`	`548`	`}`
`550`	`549`	`}`
`@@ -553,32 +552,23 @@ private void InitializeSchemaCollection(object? sender, NotifyCollectionChangedE`
`553`	`552`
`554`	`553`	`private static List<string?>? ConvertPossibleStringArray(JArray? array)`
`555`	`554`	`{`
`556`		`- if (array is null \|\| array.Count == 0)`
`557`		`- {`
`558`		`- return null;`
`559`		`- }`
`560`		`-`
`561`		`- if (array.Count > 0)`
	`555`	`+ if (array?.Count > 0)`
`562`	`556`	`{`
`563`	`557`	`var result = new List<string?>(array.Count);`
`564`		`- for (var i = 0; i < array.Count; i++)`
	`558`	`+ foreach (var item in array)`
`565`	`559`	`{`
`566`		`- var item = array[i];`
`567`		`- if (item.Type is JTokenType.String)`
	`560`	`+ switch (item.Type)`
`568`	`561`	`{`
`569`		`- result.Add(null);`
`570`		`- }`
`571`		`- else if (item.Type is JTokenType.Null)`
`572`		`- {`
`573`		`- result.Add(null);`
`574`		`- }`
`575`		`- else`
`576`		`- {`
`577`		`- // we stop processing as we don't to trust the content`
`578`		`- return null;`
	`562`	`+ case JTokenType.String:`
	`563`	`+ result.Add(item.Value<string>());`
	`564`	`+ break;`
	`565`	`+ case JTokenType.Null:`
	`566`	`+ result.Add(null);`
	`567`	`+ break;`
	`568`	`+ default:`
	`569`	`+ return null; // unsupported token type, abort`
`579`	`570`	`}`
`580`	`571`	`}`
`581`		`-`
`582`	`572`	`return result;`
`583`	`573`	`}`
`584`	`574`