Add test to validate parsing of 3.1 JSON schema keywords and update public API

Author: MaggieKimani1

test/Microsoft.OpenApi.Readers.Tests/V31Tests/OpenApiSchemaTests.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 System.Collections.Generic;
@@ -404,5 +404,51 @@ public void LoadSchemaWithNullableExtensionAsV31Works(string filePath)
             // Assert
             schema.Type.Should().BeEquivalentTo(new string[] { "string", "null" });
         }
+
+        [Fact]
+        public void SerializeSchemaWithJsonSchemaKeywordsWorks()
+        {
+            // Arrange
+            var expected = @"$id: https://example.com/schemas/person.schema.yaml
+$schema: https://json-schema.org/draft/2020-12/schema
+$comment: A schema defining a person object with optional references to dynamic components.
+$vocabulary:
+  https://json-schema.org/draft/2020-12/vocab/core: true
+  https://json-schema.org/draft/2020-12/vocab/applicator: true
+  https://json-schema.org/draft/2020-12/vocab/validation: true
+  https://json-schema.org/draft/2020-12/vocab/meta-data: false
+  https://json-schema.org/draft/2020-12/vocab/format-annotation: false
+$dynamicAnchor: addressDef
+title: Person
+required:
+  - name
+type: object
+properties:
+  name:
+    $comment: The person's full name
+    type: string
+  age:
+    $comment: Age must be a non-negative integer
+    minimum: 0
+    type: integer
+  address:
+    $comment: Reference to an address definition which can change dynamically
+    $dynamicRef: '#addressDef'
+description: Schema for a person object
+";
+            var path = Path.Combine(SampleFolderPath, "schemaWithJsonSchemaKeywords.yaml");
+
+            // Act
+            var schema = OpenApiModelFactory.Load<OpenApiSchema>(path, OpenApiSpecVersion.OpenApi3_1, out _);
+
+            // serialization
+            var writer = new StringWriter();
+            schema.SerializeAsV31(new OpenApiYamlWriter(writer));
+            var schemaString = writer.ToString();
+
+            // Assert
+            schema.Vocabulary.Keys.Count.Should().Be(5);
+            schemaString.MakeLineBreaksEnvironmentNeutral().Should().Be(expected.MakeLineBreaksEnvironmentNeutral());
+        }
     }
 }

test/Microsoft.OpenApi.Readers.Tests/V31Tests/Samples/OpenApiSchema/schemaWithJsonSchemaKeywords.yaml

@@ -0,0 +1,41 @@
+$schema: "https://json-schema.org/draft/2020-12/schema"
+$id: "https://example.com/schemas/person.schema.yaml"
+$comment: "A schema defining a person object with optional references to dynamic components."
+$vocabulary:
+  "https://json-schema.org/draft/2020-12/vocab/core": true
+  "https://json-schema.org/draft/2020-12/vocab/applicator": true
+  "https://json-schema.org/draft/2020-12/vocab/validation": true
+  "https://json-schema.org/draft/2020-12/vocab/meta-data": false
+  "https://json-schema.org/draft/2020-12/vocab/format-annotation": false
+
+title: "Person"
+description: "Schema for a person object"
+type: "object"
+
+properties:
+  name:
+    type: "string"
+    $comment: "The person's full name"
+  age:
+    type: "integer"
+    minimum: 0
+    $comment: "Age must be a non-negative integer"
+  address:
+    $dynamicRef: "#addressDef"
+    $comment: "Reference to an address definition which can change dynamically"
+  
+required:
+  - name
+
+$dynamicAnchor: "addressDef"
+definitions:
+  address:
+    $dynamicAnchor: "addressDef"
+    type: "object"
+    properties:
+      street:
+        type: "string"
+      city:
+        type: "string"
+      postalCode:
+        type: "string"

test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

@@ -912,7 +912,7 @@ namespace Microsoft.OpenApi.Models
         public virtual bool UnresolvedReference { get; set; }
         public virtual decimal? V31ExclusiveMaximum { get; set; }
         public virtual decimal? V31ExclusiveMinimum { get; set; }
-        public virtual string Vocabulary { get; set; }
+        public virtual System.Collections.Generic.IDictionary<string, bool> Vocabulary { get; set; }
         public virtual bool WriteOnly { get; set; }
         public virtual Microsoft.OpenApi.Models.OpenApiXml Xml { get; set; }
         public virtual void SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
@@ -1250,7 +1250,7 @@ namespace Microsoft.OpenApi.Models.References
         public override bool? UniqueItems { get; set; }
         public override decimal? V31ExclusiveMaximum { get; set; }
         public override decimal? V31ExclusiveMinimum { get; set; }
-        public override string Vocabulary { get; set; }
+        public override System.Collections.Generic.IDictionary<string, bool> Vocabulary { get; set; }
         public override bool WriteOnly { get; set; }
         public override Microsoft.OpenApi.Models.OpenApiXml Xml { get; set; }
         public override void SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
@@ -1845,6 +1845,7 @@ namespace Microsoft.OpenApi.Writers
     {
         public static void WriteOptionalCollection(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, System.Collections.Generic.IEnumerable<string> elements, System.Action<Microsoft.OpenApi.Writers.IOpenApiWriter, string> action) { }
         public static void WriteOptionalCollection<T>(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, System.Collections.Generic.IEnumerable<T> elements, System.Action<Microsoft.OpenApi.Writers.IOpenApiWriter, T> action) { }
+        public static void WriteOptionalMap(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, System.Collections.Generic.IDictionary<string, bool> elements, System.Action<Microsoft.OpenApi.Writers.IOpenApiWriter, bool> action) { }
         public static void WriteOptionalMap(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, System.Collections.Generic.IDictionary<string, string> elements, System.Action<Microsoft.OpenApi.Writers.IOpenApiWriter, string> action) { }
         public static void WriteOptionalMap<T>(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, System.Collections.Generic.IDictionary<string, T> elements, System.Action<Microsoft.OpenApi.Writers.IOpenApiWriter, T> action)
             where T : Microsoft.OpenApi.Interfaces.IOpenApiElement { }