feat: Make REQUIRED properties as non-nullable and revert some changes according this.

HavenDV · HavenDV · commit 45b0e5ea7388 · 2024-09-06T02:52:24.000+04:00
diff --git a/src/Microsoft.OpenApi.Hidi/OpenApiService.cs b/src/Microsoft.OpenApi.Hidi/OpenApiService.cs
@@ -185,7 +185,7 @@ private static OpenApiDocument ApplyFilters(HidiOptions options, ILogger logger,
                 stopwatch.Start();
                 document = OpenApiFilterService.CreateFilteredDocument(document, predicate);
                 stopwatch.Stop();
-                logger.LogTrace("{Timestamp}ms: Creating filtered OpenApi document with {Paths} paths.", stopwatch.ElapsedMilliseconds, document.Paths?.Count);
+                logger.LogTrace("{Timestamp}ms: Creating filtered OpenApi document with {Paths} paths.", stopwatch.ElapsedMilliseconds, document.Paths.Count);
             }
 
             return document;
@@ -248,7 +248,7 @@ private static async Task<OpenApiDocument> GetOpenApi(HidiOptions options, strin
 
                     document = await ConvertCsdlToOpenApi(filteredStream ?? stream, format, metadataVersion, options.SettingsConfig, cancellationToken).ConfigureAwait(false);
                     stopwatch.Stop();
-                    logger.LogTrace("{Timestamp}ms: Generated OpenAPI with {Paths} paths.", stopwatch.ElapsedMilliseconds, document.Paths?.Count);
+                    logger.LogTrace("{Timestamp}ms: Generated OpenAPI with {Paths} paths.", stopwatch.ElapsedMilliseconds, document.Paths.Count);
                 }
             }
             else if (!string.IsNullOrEmpty(options.OpenApi))
@@ -666,7 +666,7 @@ internal static void WriteTreeDocumentAsMarkdown(string openapiUrl, OpenApiDocum
         {
             var rootNode = OpenApiUrlTreeNode.Create(document, "main");
 
-            writer.WriteLine("# " + document.Info?.Title);
+            writer.WriteLine("# " + document.Info.Title);
             writer.WriteLine();
             writer.WriteLine("API Description: " + openapiUrl);
 
@@ -702,7 +702,7 @@ internal static void WriteTreeDocumentAsHtml(string sourceUrl, OpenApiDocument d
                 </style>
                 <body>
                 """);
-            writer.WriteLine("<h1>" + document.Info?.Title + "</h1>");
+            writer.WriteLine("<h1>" + document.Info.Title + "</h1>");
             writer.WriteLine();
             writer.WriteLine($"<h3> API Description: <a href='{sourceUrl}'>{sourceUrl}</a></h3>");
 
@@ -773,8 +773,8 @@ internal static async Task PluginManifest(HidiOptions options, ILogger logger, C
             // Create OpenAIPluginManifest from ApiDependency and OpenAPI document
             var manifest = new OpenAIPluginManifest
             {
-                NameForHuman = document.Info?.Title,
-                DescriptionForHuman = document.Info?.Description,
+                NameForHuman = document.Info.Title,
+                DescriptionForHuman = document.Info.Description,
                 Api = new()
                 {
                     Type = "openapi",
diff --git a/src/Microsoft.OpenApi/Models/OpenApiDocument.cs b/src/Microsoft.OpenApi/Models/OpenApiDocument.cs
@@ -33,7 +33,7 @@ public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible
         /// <summary>
         /// REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
         /// </summary>
-        public OpenApiInfo? Info { get; set; }
+        public OpenApiInfo Info { get; set; }
 
         /// <summary>
         /// The default value for the $schema keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.
@@ -48,7 +48,7 @@ public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible
         /// <summary>
         /// REQUIRED. The available paths and operations for the API.
         /// </summary>
-        public OpenApiPaths? Paths { get; set; }
+        public OpenApiPaths Paths { get; set; }
 
         /// <summary>
         /// The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement.
@@ -100,6 +100,8 @@ public OpenApiDocument()
         {
             Workspace = new OpenApiWorkspace();
             BaseUri = new(OpenApiConstants.BaseRegistryUri + Guid.NewGuid());
+            Info = new OpenApiInfo();
+            Paths = new OpenApiPaths();
         }
                 
         /// <summary>
@@ -108,10 +110,10 @@ public OpenApiDocument()
         public OpenApiDocument(OpenApiDocument? document)
         {
             Workspace = document?.Workspace != null ? new(document?.Workspace) : null;
-            Info = document?.Info != null ? new(document?.Info) : null;
+            Info = document?.Info != null ? new(document?.Info) : new OpenApiInfo();
             JsonSchemaDialect = document?.JsonSchemaDialect ?? JsonSchemaDialect;
             Servers = document?.Servers != null ? new List<OpenApiServer>(document.Servers) : null;
-            Paths = document?.Paths != null ? new(document?.Paths) : null;
+            Paths = document?.Paths != null ? new(document?.Paths) : new OpenApiPaths();
             Webhooks = document?.Webhooks != null ? new Dictionary<string, OpenApiPathItem>(document.Webhooks) : null;
             Components = document?.Components != null ? new(document?.Components) : null;
             SecurityRequirements = document?.SecurityRequirements != null ? new List<OpenApiSecurityRequirement>(document.SecurityRequirements) : null;
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Formatters/PowerShellFormatterTests.cs b/test/Microsoft.OpenApi.Hidi.Tests/Formatters/PowerShellFormatterTests.cs
@@ -86,12 +86,12 @@ public void ResolveFunctionParameters()
             var walker = new OpenApiWalker(powerShellFormatter);
             walker.Walk(openApiDocument);
 
-            var idsParameter = openApiDocument.Paths?["/foo"].Operations[OperationType.Get].Parameters?.Where(static p => p.Name == "ids").FirstOrDefault();
+            var idsParameter = openApiDocument.Paths["/foo"].Operations[OperationType.Get].Parameters?.Where(static p => p.Name == "ids").FirstOrDefault();
 
             // Assert
             Assert.Null(idsParameter?.Content);
             Assert.NotNull(idsParameter?.Schema);
-            Assert.Equal("array", idsParameter.Schema.Type);
+            Assert.Equal("array", idsParameter?.Schema.Type);
         }
 
         private static OpenApiDocument GetSampleOpenApiDocument()
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs b/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs
@@ -43,7 +43,6 @@ public void ReturnFilteredOpenApiDocumentBasedOnOperationIdsAndTags(string? oper
 
             // Assert
             Assert.NotNull(subsetOpenApiDocument);
-            Assert.NotNull(subsetOpenApiDocument.Paths);
             Assert.NotEmpty(subsetOpenApiDocument.Paths);
             Assert.Equal(expectedPathCount, subsetOpenApiDocument.Paths.Count);
         }
@@ -63,7 +62,6 @@ public void ReturnFilteredOpenApiDocumentBasedOnPostmanCollection()
 
             // Assert
             Assert.NotNull(subsetOpenApiDocument);
-            Assert.NotNull(subsetOpenApiDocument.Paths);
             Assert.NotEmpty(subsetOpenApiDocument.Paths);
             Assert.Equal(3, subsetOpenApiDocument.Paths.Count);
         }
@@ -152,11 +150,10 @@ public void ContinueProcessingWhenUrlsInCollectionAreMissingFromSourceDocument()
             var pathCount = requestUrls.Count;
             var predicate = OpenApiFilterService.CreatePredicate(requestUrls: requestUrls, source: _openApiDocumentMock);
             var subsetOpenApiDocument = OpenApiFilterService.CreateFilteredDocument(_openApiDocumentMock, predicate);
-            var subsetPathCount = subsetOpenApiDocument.Paths?.Count;
+            var subsetPathCount = subsetOpenApiDocument.Paths.Count;
 
             // Assert
             Assert.NotNull(subsetOpenApiDocument);
-            Assert.NotNull(subsetOpenApiDocument.Paths);
             Assert.NotEmpty(subsetOpenApiDocument.Paths);
             Assert.Equal(2, subsetPathCount);
             Assert.NotEqual(pathCount, subsetPathCount);
@@ -183,7 +180,6 @@ public void ReturnsPathParametersOnSlicingBasedOnOperationIdsOrTags(string? oper
             var subsetOpenApiDocument = OpenApiFilterService.CreateFilteredDocument(_openApiDocumentMock, predicate);
 
             // Assert
-            Assert.NotNull(subsetOpenApiDocument.Paths);
             foreach (var pathItem in subsetOpenApiDocument.Paths)
             {
                 Assert.True(pathItem.Value.Parameters.Any());
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
@@ -537,9 +537,9 @@ namespace Microsoft.OpenApi.Models
         public System.Collections.Generic.IDictionary<string, Microsoft.OpenApi.Interfaces.IOpenApiExtension>? Extensions { get; set; }
         public Microsoft.OpenApi.Models.OpenApiExternalDocs? ExternalDocs { get; set; }
         public string HashCode { get; }
-        public Microsoft.OpenApi.Models.OpenApiInfo? Info { get; set; }
+        public Microsoft.OpenApi.Models.OpenApiInfo Info { get; set; }
         public string? JsonSchemaDialect { get; set; }
-        public Microsoft.OpenApi.Models.OpenApiPaths? Paths { get; set; }
+        public Microsoft.OpenApi.Models.OpenApiPaths Paths { get; set; }
         public System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiSecurityRequirement>? SecurityRequirements { get; set; }
         public System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiServer>? Servers { get; set; }
         public System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiTag>? Tags { get; set; }
diff --git a/test/Microsoft.OpenApi.Tests/Walkers/WalkerLocationTests.cs b/test/Microsoft.OpenApi.Tests/Walkers/WalkerLocationTests.cs
@@ -24,7 +24,9 @@ public void LocateTopLevelObjects()
             walker.Walk(doc);
 
             locator.Locations.Should().BeEquivalentTo(new List<string> {
+                "#/info",
                 "#/servers",
+                "#/paths",
                 "#/tags"
             });
         }
@@ -39,7 +41,6 @@ public void LocateTopLevelArrayItems()
                     new(),
                     new()
                 },
-                Paths = new(),
                 Tags = new List<OpenApiTag>
                 {
                     new()
@@ -51,6 +52,7 @@ public void LocateTopLevelArrayItems()
             walker.Walk(doc);
 
             locator.Locations.Should().BeEquivalentTo(new List<string> {
+                "#/info",
                 "#/servers",
                 "#/servers/0",
                 "#/servers/1",
@@ -63,10 +65,7 @@ public void LocateTopLevelArrayItems()
         [Fact]
         public void LocatePathOperationContentSchema()
         {
-            var doc = new OpenApiDocument
-            {
-                Paths = new()
-            };
+            var doc = new OpenApiDocument();
             doc.Paths.Add("/test", new()
             {
                 Operations = new Dictionary<OperationType, OpenApiOperation>
@@ -98,6 +97,7 @@ public void LocatePathOperationContentSchema()
             walker.Walk(doc);
 
             locator.Locations.Should().BeEquivalentTo(new List<string> {
+                "#/info",
                 "#/servers",
                 "#/paths",
                 "#/paths/~1test",
@@ -131,7 +131,6 @@ public void WalkDOMWithCycles()
 
             var doc = new OpenApiDocument
             {
-                Paths = new(),
                 Components = new()
                 {
                     Schemas = new Dictionary<string, OpenApiSchema>
@@ -146,6 +145,7 @@ public void WalkDOMWithCycles()
             walker.Walk(doc);
 
             locator.Locations.Should().BeEquivalentTo(new List<string> {
+                "#/info",
                 "#/servers",
                 "#/paths",
                 "#/components",
