feat: add support for dependentRequired

src/Microsoft.OpenApi/Models/Interfaces/IOpenApiSchema.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Text.Json.Nodes;
 using Microsoft.OpenApi.Interfaces;
 
@@ -299,4 +299,9 @@ public interface IOpenApiSchema : IOpenApiDescribedElement, IOpenApiSerializable
     /// Annotations are NOT (de)serialized with the schema and can be used for custom properties.
     /// </summary>
     public IDictionary<string, object> Annotations { get; }
+
+    /// <summary>
+    /// Follow JSON Schema definition:https://tools.ietf.org/html/draft-handrews-json-schema-validation-02
+    /// </summary>
+    public IDictionary<string, ISet<string>> DependentRequired { get; }
 }

src/Microsoft.OpenApi/Models/OpenApiConstants.cs

@@ -693,17 +693,17 @@
         /// <summary>
         /// Field: V3 JsonSchema Reference Uri
         /// </summary>
         public const string V3ReferenceUri = "https://registry/components/schemas/";
 
         /// <summary>
         /// Field: V2 JsonSchema Reference Uri
         /// </summary>
         public const string V2ReferenceUri = "https://registry/definitions/";
 
         /// <summary>
         /// The default registry uri for OpenApi documents and workspaces
         /// </summary>
         public const string BaseRegistryUri = "https://openapi.net/";
 
         /// <summary>
         /// The components path segment in a $ref value.
@@ -720,6 +720,11 @@
         /// </summary>
         public const string NullableExtension = "x-nullable";
 
+        /// <summary>
+        /// Field: DependentRequired
+        /// </summary>
+        public const string DependentRequired = "dependentRequired";
+
         #region V2.0
 
         /// <summary>

src/Microsoft.OpenApi/Models/OpenApiSchema.cs

@@ -176,6 +176,9 @@ public class OpenApiSchema : IOpenApiReferenceable, IOpenApiExtensible, IOpenApi
         /// <inheritdoc />
         public IDictionary<string, object> Annotations { get; set; }
 
+        /// <inheritdoc />
+        public IDictionary<string, ISet<string>> DependentRequired { get; set; } = new Dictionary<string, ISet<string>>();
+
         /// <summary>
         /// Parameterless constructor
         /// </summary>
@@ -239,6 +242,7 @@ internal OpenApiSchema(IOpenApiSchema schema)
             Extensions = schema.Extensions != null ? new Dictionary<string, IOpenApiExtension>(schema.Extensions) : null;
             Annotations = schema.Annotations != null ? new Dictionary<string, object>(schema.Annotations) : null;
             UnrecognizedKeywords = schema.UnrecognizedKeywords != null ? new Dictionary<string, JsonNode>(schema.UnrecognizedKeywords) : null;
+            DependentRequired = schema.DependentRequired != null ? new Dictionary<string, ISet<string>>(schema.DependentRequired) : null;
         }
 
         /// <inheritdoc />
@@ -408,6 +412,7 @@ internal void WriteJsonSchemaKeywords(IOpenApiWriter writer)
             writer.WriteProperty(OpenApiConstants.UnevaluatedProperties, UnevaluatedProperties, false);
             writer.WriteOptionalCollection(OpenApiConstants.Examples, Examples, (nodeWriter, s) => nodeWriter.WriteAny(s));
             writer.WriteOptionalMap(OpenApiConstants.PatternProperties, PatternProperties, (w, s) => s.SerializeAsV31(w));
+            writer.WriteOptionalMap(OpenApiConstants.DependentRequired, DependentRequired, (w, s) => w.WriteValue(s));
         }
 
         internal void WriteAsItemsProperties(IOpenApiWriter writer)

src/Microsoft.OpenApi/Models/References/OpenApiSchemaReference.cs

@@ -154,6 +154,9 @@ public string Description
         /// <inheritdoc/>
         public IDictionary<string, object> Annotations { get => Target?.Annotations; }
 
+        /// <inheritdoc/>
+        public IDictionary<string, ISet<string>> DependentRequired { get => Target?.DependentRequired; }
+
         /// <inheritdoc/>
         public override void SerializeAsV31(IOpenApiWriter writer)
         {

src/Microsoft.OpenApi/Reader/ParseNodes/MapNode.cs

@@ -103,6 +103,34 @@ public override Dictionary<string, T> CreateSimpleMap<T>(Func<ValueNode, T> map)
             return nodes.ToDictionary(k => k.key, v => v.value);
         }
 
+        public override Dictionary<string, ISet<T>> CreateArrayMap<T>(Func<ValueNode, OpenApiDocument, T> map, OpenApiDocument openApiDocument)
+        {
+            var jsonMap = _node ?? throw new OpenApiReaderException($"Expected map while parsing {typeof(T).Name}", Context);
+
+            var nodes = jsonMap.Select(n =>
+            {
+                var key = n.Key;
+                try
+                {
+                    Context.StartObject(key);
+                    JsonArray arrayNode = n.Value is JsonArray value
+                        ? value
+                        : throw new OpenApiReaderException($"Expected array while parsing {typeof(T).Name}", Context);
+
+                    ISet<T> values = new HashSet<T>(arrayNode.Select(item => map(new ValueNode(Context, item), openApiDocument)));
+
+                    return (key, values);
+
+                }
+                finally
+                {
+                    Context.EndObject();
+                }
+            });
+
+            return nodes.ToDictionary(kvp => kvp.key, kvp => kvp.values);
+        }
+
         public IEnumerator<PropertyNode> GetEnumerator()
         {
             return _nodes.GetEnumerator();

src/Microsoft.OpenApi/Reader/ParseNodes/ParseNode.cs

@@ -23,7 +23,7 @@
 
         public MapNode CheckMapNode(string nodeName)
         {
             if (this is not MapNode mapNode)
             {
                 throw new OpenApiReaderException($"{nodeName} must be a map/object", Context);
             }
@@ -84,6 +84,11 @@
         public virtual List<JsonNode> CreateListOfAny()
         {
             throw new OpenApiReaderException("Cannot create a list from this type of node.", Context);
-        }      
+        }
+
+        public virtual Dictionary<string, ISet<T>> CreateArrayMap<T>(Func<ValueNode, OpenApiDocument, T> map, OpenApiDocument openApiDocument)
+        {
+            throw new OpenApiReaderException("Cannot create array map from this type of node.", Context);
+        }
     }
 }

src/Microsoft.OpenApi/Reader/V31/OpenApiSchemaDeserializer.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
 using Microsoft.OpenApi.Extensions;
@@ -234,6 +234,13 @@ internal static partial class OpenApiV31Deserializer
                 "deprecated",
                 (o, n, _) => o.Deprecated = bool.Parse(n.GetScalarValue())
             },
+            {
+                "dependentRequired",
+                (o, n, doc) =>
+                {
+                    o.DependentRequired = n.CreateArrayMap((n2, p) => n2.GetScalarValue(), doc);
+                }
+            },
         };
 
         private static readonly PatternFieldMap<OpenApiSchema> _openApiSchemaPatternFields = new()

src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs

@@ -2,9 +2,11 @@
 // Licensed under the MIT license.
 
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Globalization;
 using System.IO;
+using System.Reflection;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Exceptions;
@@ -136,7 +138,7 @@
         /// Write float value.
         /// </summary>
         /// <param name="value">The float value.</param>
         public virtual void WriteValue(float value)
         {
             WriteValueSeparator();
             Writer.Write(value);
@@ -210,11 +212,25 @@
             Writer.Write(value.ToString().ToLower());
         }
 
+        /// <summary>
+        /// Write hashSet value.
+        /// </summary>
+        /// <param name="value">The HashSet value.</param>
+        public virtual void WriteHashSet(IEnumerable<object> value)
+        {
+            WriteStartArray();
+            foreach (var item in value)
+            {
+                WriteValue(item);
+            }
+            WriteEndArray();
+        }
+
         /// <summary>
         /// Write object value.
         /// </summary>
         /// <param name="value">The object value.</param>
         public virtual void WriteValue(object value)
         {
             if (value == null)
             {
@@ -264,6 +280,10 @@
             {
                 WriteValue((DateTimeOffset)value);
             }
+            else if (value is IEnumerable<object> hashSet && value.GetType().GetGenericTypeDefinition() == typeof(HashSet<>))
+            {
+                WriteHashSet(hashSet);
+            }
             else
             {
                 throw new OpenApiWriterException(string.Format(SRResource.OpenApiUnsupportedValueType, type.FullName));

src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs

@@ -21,7 +21,7 @@
         /// <param name="writer">The writer.</param>
         /// <param name="name">The property name.</param>
         /// <param name="value">The property value.</param>
         public static void WriteProperty(this IOpenApiWriter writer, string name, string value)
         {
             if (value == null)
             {
@@ -141,7 +141,7 @@
             T? value,
             Action<IOpenApiWriter, T> action)
         {
             if (value != null)
             {
                 if (value is IEnumerable values && !values.GetEnumerator().MoveNext())
                 {
@@ -169,7 +169,7 @@
             Utils.CheckArgumentNull(action);
 
             writer.WritePropertyName(name);
             if (value != null)
             {
                 action(writer, value);
             }
@@ -245,7 +245,7 @@
         /// <param name="name">The property name.</param>
         /// <param name="elements">The map values.</param>
         /// <param name="action">The map element writer action.</param>
         public static void WriteRequiredMap(
             this IOpenApiWriter writer,
             string name,
             IDictionary<string, string> elements,
@@ -311,6 +311,25 @@
             }
         }
 
+        /// <summary>
+        /// Write the optional Open API element map (string to array mapping).
+        /// </summary>
+        /// <param name="writer">The Open API writer.</param>
+        /// <param name="name">The property name.</param>
+        /// <param name="elements">The map values.</param>
+        /// <param name="action">The map element writer action.</param>
+        public static void WriteOptionalMap(
+            this IOpenApiWriter writer,
+            string name,
+            IDictionary<string, ISet<string>> elements,
+            Action<IOpenApiWriter, ISet<string>> action)
+        {
+            if (elements != null && elements.Any())
+            {
+                writer.WriteMapInternal(name, elements, action);
+            }
+        }
+
         /// <summary>
         /// Write the optional Open API element map.
         /// </summary>

test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiDocumentTests.cs

@@ -46,6 +46,10 @@ public async Task ParseDocumentWithWebhooksShouldSucceed()
                             "id",
                             "name"
                         },
+                        DependentRequired = new Dictionary<string, ISet<string>>
+                        {
+                            { "tag", new HashSet<string> { "category" } }
+                        },
                         Properties = new Dictionary<string, IOpenApiSchema>
                         {
                             ["id"] = new OpenApiSchema()
@@ -61,6 +65,10 @@ public async Task ParseDocumentWithWebhooksShouldSucceed()
                             {
                                 Type = JsonSchemaType.String
                             },
+                            ["category"] = new OpenApiSchema()
+                            {
+                                Type = JsonSchemaType.String,
+                            },
                         }
                     },
                     ["newPetSchema"] = new OpenApiSchema()
@@ -70,6 +78,10 @@ public async Task ParseDocumentWithWebhooksShouldSucceed()
                         {
                             "name"
                         },
+                        DependentRequired = new Dictionary<string, ISet<string>>
+                        {
+                            { "tag", new HashSet<string> { "category" } }
+                        },
                         Properties = new Dictionary<string, IOpenApiSchema>
                         {
                             ["id"] = new OpenApiSchema()
@@ -85,6 +97,10 @@ public async Task ParseDocumentWithWebhooksShouldSucceed()
                             {
                                 Type = JsonSchemaType.String
                             },
+                            ["category"] = new OpenApiSchema()
+                            {
+                                Type = JsonSchemaType.String,
+                            },
                         }
                     }
                 }
@@ -222,6 +238,10 @@ public async Task ParseDocumentsWithReusablePathItemInWebhooksSucceeds()
                             "id",
                             "name"
                         },
+                        DependentRequired = new Dictionary<string, ISet<string>>
+                        {
+                            { "tag", new HashSet<string> { "category" } }
+                        },
                         Properties = new Dictionary<string, IOpenApiSchema>
                         {
                             ["id"] = new OpenApiSchema()
@@ -237,6 +257,10 @@ public async Task ParseDocumentsWithReusablePathItemInWebhooksSucceeds()
                             {
                                 Type = JsonSchemaType.String
                             },
+                            ["category"] = new OpenApiSchema()
+                            {
+                                Type = JsonSchemaType.String,
+                            },
                         }
                     },
                     ["newPetSchema"] = new OpenApiSchema()
@@ -246,6 +270,10 @@ public async Task ParseDocumentsWithReusablePathItemInWebhooksSucceeds()
                         {
                             "name"
                         },
+                        DependentRequired = new Dictionary<string, ISet<string>>
+                        {
+                            { "tag", new HashSet<string> { "category" } }
+                        },
                         Properties = new Dictionary<string, IOpenApiSchema>
                         {
                             ["id"] = new OpenApiSchema()
@@ -261,6 +289,10 @@ public async Task ParseDocumentsWithReusablePathItemInWebhooksSucceeds()
                             {
                                 Type = JsonSchemaType.String
                             },
+                            ["category"] = new OpenApiSchema()
+                            {
+                                Type = JsonSchemaType.String,
+                            },
                         }
                     }
                 }

test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiSchemaTests.cs

@@ -68,6 +68,10 @@ public async Task ParseBasicV31SchemaShouldSucceed()
                             "veggieName",
                             "veggieLike"
                         },
+                        DependentRequired = new Dictionary<string, ISet<string>>
+                        {
+                            { "veggieType", new HashSet<string> { "veggieColor", "veggieSize" } }
+                        },
                         Properties = new Dictionary<string, IOpenApiSchema>
                         {
                             ["veggieName"] = new OpenApiSchema
@@ -79,6 +83,21 @@ public async Task ParseBasicV31SchemaShouldSucceed()
                             {
                                 Type = JsonSchemaType.Boolean,
                                 Description = "Do I like this vegetable?"
+                            },
+                            ["veggieType"] = new OpenApiSchema
+                            {
+                                Type = JsonSchemaType.String,
+                                Description = "The type of vegetable (e.g., root, leafy, etc.)."
+                            },
+                            ["veggieColor"] = new OpenApiSchema
+                            {
+                                Type = JsonSchemaType.String,
+                                Description = "The color of the vegetable."
+                            },
+                            ["veggieSize"] = new OpenApiSchema
+                            {
+                                Type = JsonSchemaType.String,
+                                Description = "The size of the vegetable."
                             }
                         }
                     }

test/Microsoft.OpenApi.Readers.Tests/V31Tests/Samples/OpenApiDocument/documentWithReusablePaths.yaml

@@ -13,6 +13,9 @@ components:
         required:
         - id
         - name
+        dependentRequired:
+          tag:
+            - category
         properties:
             id:
               type: integer
@@ -21,10 +24,15 @@ components:
               type: string
             tag:
               type: string
+            category:
+              type: string
     newPetSchema:
         type: object
         required:
         - name
+        dependentRequired:
+          tag:
+            - category
         properties:
             id:
               type: integer
@@ -33,6 +41,8 @@ components:
               type: string
             tag:
               type: string
+            category:
+              type: string
   pathItems:
      pets:
         get:

test/Microsoft.OpenApi.Readers.Tests/V31Tests/Samples/OpenApiDocument/documentWithWebhooks.yaml

@@ -59,6 +59,9 @@ components:
         required:
         - id
         - name
+        dependentRequired:
+          tag:
+           - category
         properties:
             id:
               type: integer
@@ -67,15 +70,22 @@ components:
               type: string
             tag:
               type: string
+            category:
+              type: string
     newPetSchema:
         type: object
         required:
         - name
+        dependentRequired:
+          tag:
+           - category
         properties:
             id:
               type: integer
               format: int64
             name:
               type: string
             tag:
+              type: string
+            category:
               type: string