Fix empty objects in plugin manifests by omitting them instead of serializing empty {} #6945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

Copilot wants to merge 12 commits into main from copilot/fix-6944

src/Kiota.Builder/LanguageInformation.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -85,6 +85,11 @@ @@
             }
             return extension;
         }
+        public override bool Equals(object obj)
+        {
+            return Equals(obj as LanguageInformation);
+        }
     }
     public record LanguageDependency : IOpenApiSerializable
     {
@@ Expand Down Expand Up / @@ -130,6 +135,11 @@ @@
             }
             return extension;
         }
+        public override bool Equals(object obj)
+        {
+            return Equals(obj as LanguageDependency);
+        }
     }
     public enum LanguageMaturityLevel
@@ Expand Down @@

src/Kiota.Builder/OpenApiExtensions/OpenApiAiAdaptiveCardExtension.cs

-Original file line number
+Diff line change
@@ Expand Up @@
         public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
             ArgumentNullException.ThrowIfNull(writer);
-            writer.WriteStartObject();
+            // Only write the object if there's actual content to write
             if (!string.IsNullOrEmpty(DataPath) && !string.IsNullOrEmpty(File) && !string.IsNullOrEmpty(Title))
             {
+                writer.WriteStartObject();
                 writer.WritePropertyName(nameof(DataPath).ToFirstCharacterLowerCase().ToSnakeCase());
                 writer.WriteValue(DataPath);
                 writer.WritePropertyName(nameof(File).ToFirstCharacterLowerCase());
@@ Expand All @@
                     writer.WritePropertyName(nameof(Url).ToFirstCharacterLowerCase());
                     writer.WriteValue(Url);
                 }
+                writer.WriteEndObject();
             }
-            writer.WriteEndObject();
         }
     }

src/Kiota.Builder/OpenApiExtensions/OpenApiAiCapabilitiesExtension.cs

-Original file line number
+Diff line change
@@ Expand Up @@
         public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
             ArgumentNullException.ThrowIfNull(writer);
-            writer.WriteStartObject();
+            // Only write the object if there's actual content to write
             if (ResponseSemantics != null || Confirmation != null || SecurityInfo != null)
             {
+                writer.WriteStartObject();
                 if (ResponseSemantics is not null)
                 {
@@ Expand All @@
                     writer.WritePropertyName(nameof(SecurityInfo).ToFirstCharacterLowerCase().ToSnakeCase());
                     WriteSecurityInfo(writer, SecurityInfo);
                 }
+                writer.WriteEndObject();
             }
-            writer.WriteEndObject();
         }
         private static ExtensionConfirmation ParseConfirmation(JsonObject source)
@@ Expand Down @@

src/Kiota.Builder/OpenApiExtensions/OpenApiLogoExtension.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -29,12 +29,13 @@ public static OpenApiLogoExtension Parse(JsonNode source) @@
         public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
             ArgumentNullException.ThrowIfNull(writer);
-            writer.WriteStartObject();
+            // Only write the object if there's actual content to write
             if (!string.IsNullOrEmpty(Url))
             {
+                writer.WriteStartObject();
                 writer.WritePropertyName(nameof(Url).ToFirstCharacterLowerCase());
                 writer.WriteValue(Url);
+                writer.WriteEndObject();
             }
-            writer.WriteEndObject();
         }
     }

src/Kiota.Builder/Plugins/PluginsGenerationService.cs

-Original file line number
+Diff line change
@@ Expand Up @@
                         Capabilities = GetFunctionCapabilitiesFromOperation(operation, configuration, logger),
                     });
-                    conversationStarters.Add(new ConversationStarter
+                    // Don't create conversation starters for operations that have empty x-ai-capabilities
+                    var hasEmptyCapabilities = operation.Extensions is not null &&
+                        operation.Extensions.TryGetValue(OpenApiAiCapabilitiesExtension.Name, out var capExt) &&
+                        capExt is OpenApiAiCapabilitiesExtension cap &&
+                        cap.ResponseSemantics == null &&
+                        cap.Confirmation == null &&
+                        cap.SecurityInfo == null;
+                    if (!hasEmptyCapabilities)
                     {
-                        Text = !string.IsNullOrEmpty(summary) ? summary : description
-                    });
+                        conversationStarters.Add(new ConversationStarter
+                        {
+                            Text = !string.IsNullOrEmpty(summary) ? summary : description
+                        });
+                    }
                 }
             }
@@ Expand Down Expand Up / @@ -1136,6 +1148,7 @@ rExtRaw is T rExt && @@
                 capabilitiesExtension is OpenApiAiCapabilitiesExtension capabilities)
             {
                 var functionCapabilities = new FunctionCapabilities();
+                bool hasContent = false;
                 // Set ResponseSemantics
                 if (capabilities.ResponseSemantics is not null)
@@ Expand Down Expand Up / @@ -1163,6 +1176,7 @@ rExtRaw is T rExt && @@
                     }
                     responseSemantics.OAuthCardPath = capabilities.ResponseSemantics.OauthCardPath;
                     functionCapabilities.ResponseSemantics = responseSemantics;
+                    hasContent = true;
                 }
                 // Set Confirmation
@@ Expand All / @@ -1175,6 +1189,7 @@ rExtRaw is T rExt && @@
                         Body = capabilities.Confirmation.Body,
                     };
                     functionCapabilities.Confirmation = confirmation;
+                    hasContent = true;
                 }
                 // Set SecurityInfo
@@ Expand All / @@ -1185,8 +1200,11 @@ rExtRaw is T rExt && @@
                         DataHandling = capabilities.SecurityInfo.DataHandling,
                     };
                     functionCapabilities.SecurityInfo = securityInfo;
+                    hasContent = true;
                 }
-                return functionCapabilities;
+                // Only return the capabilities object if it actually has content
+                return hasContent ? functionCapabilities : null;
             }
             return null;
@@ Expand Down Expand Up / @@ -1242,6 +1260,18 @@ rExtRaw is T rExt && @@
                 }
             }
+            // Don't create capabilities for operations that have empty x-ai-capabilities
+            if (openApiOperation.Extensions is not null &&
+                openApiOperation.Extensions.TryGetValue(OpenApiAiCapabilitiesExtension.Name, out var capabilitiesExtension) &&
+                capabilitiesExtension is OpenApiAiCapabilitiesExtension capabilities &&
+                capabilities.ResponseSemantics == null &&
+                capabilities.Confirmation == null &&
+                capabilities.SecurityInfo == null)
+            {
+                // If the capabilities extension exists but has no content, don't create response semantics
+                return null;
+            }
             string functionName = openApiOperation.OperationId;
             string fileName = $"{functionName}.json";
             string staticTemplateJson = $"{{\"file\": \"./adaptiveCards/{fileName}\"}}";
@@ Expand Down @@

tests/Kiota.Builder.Tests/Extensions/OpenApiSchemaExtensionsTests.cs

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -198,8 +198,8 @@ public void GetSchemaNameAnyOfReference()
  
            {

                AnyOf = [

                            new OpenApiSchemaReference("microsoft.graph.entity"),

                            new OpenApiSchemaReference("microsoft.graph.user"),

                        ]

                    new OpenApiSchemaReference("microsoft.graph.user"),

                ]

            };

            var names = schema.GetSchemaNames();

            Assert.Contains("entity", names);

    @@ -233,8 +233,8 @@ public void GetSchemaNameOneOfReference()
  
            {

                OneOf = [

                            new OpenApiSchemaReference("microsoft.graph.entity"),

                            new OpenApiSchemaReference("microsoft.graph.user"),

                        ]

                    new OpenApiSchemaReference("microsoft.graph.user"),

                ]

            };

            var names = schema.GetSchemaNames();

            Assert.Contains("entity", names);

    @@ -315,7 +315,8 @@ public void GetReferenceIdsAllOfNested()
  
            var schema = new OpenApiSchema

            {

                AllOf = [

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        AllOf = [

                            new OpenApiSchemaReference("microsoft.graph.entity"),

                            new OpenApiSchemaReference("microsoft.graph.user")

    @@ -388,9 +389,11 @@ public void IsInherited()
  
            {

                AllOf = [

                    new OpenApiSchemaReference("microsoft.graph.entity"),

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        Type = JsonSchemaType.Object,

                        Properties = new Dictionary<string, IOpenApiSchema>() {

                        Properties = new Dictionary<string, IOpenApiSchema>()

                        {

                            ["firstName"] = new OpenApiSchema()

                        }

                    }

    @@ -441,15 +444,19 @@ public void IsIntersection()
  
            schema = new OpenApiSchema

            {

                AllOf = [

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        Type = JsonSchemaType.Object,

                        Properties = new Dictionary<string, IOpenApiSchema>() {

                        Properties = new Dictionary<string, IOpenApiSchema>()

                        {

                            ["id"] = new OpenApiSchema()

                        }

                    },

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        Type = JsonSchemaType.Object,

                        Properties = new Dictionary<string, IOpenApiSchema>() {

                        Properties = new Dictionary<string, IOpenApiSchema>()

                        {

                            ["firstName"] = new OpenApiSchema()

                        }

                    }

    @@ -461,9 +468,11 @@ public void IsIntersection()
  
            schema = new OpenApiSchema

            {

                AllOf = [

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        Type = JsonSchemaType.Object,

                        Properties = new Dictionary<string, IOpenApiSchema>() {

                        Properties = new Dictionary<string, IOpenApiSchema>()

                        {

                            ["id"] = new OpenApiSchema()

                        }

                    }

    @@ -503,15 +512,19 @@ public void MergesIntersection()
  
                Description = "description",

                Deprecated = true,

                AllOf = [

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        Type = JsonSchemaType.Object,

                        Properties = new Dictionary<string, IOpenApiSchema>() {

                        Properties = new Dictionary<string, IOpenApiSchema>()

                        {

                            ["id"] = new OpenApiSchema()

                        }

                    },

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        Type = JsonSchemaType.Object,

                        Properties = new Dictionary<string, IOpenApiSchema>() {

                        Properties = new Dictionary<string, IOpenApiSchema>()

                        {

                            ["firstName"] = new OpenApiSchema()

                        }

                    }

    @@ -533,25 +546,32 @@ public void MergesIntersectionRecursively()
  
                Description = "description",

                Deprecated = true,

                AllOf = [

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        Type = JsonSchemaType.Object,

                        Properties = new Dictionary<string, IOpenApiSchema>() {

                        Properties = new Dictionary<string, IOpenApiSchema>()

                        {

                            ["id"] = new OpenApiSchema()

                        }

                    },

                    new OpenApiSchema() {

                    new OpenApiSchema()

                    {

                        Type = JsonSchemaType.Object,

                        AllOf = [

                            new OpenApiSchema() {

                            new OpenApiSchema()

                            {

                                Type = JsonSchemaType.Object,

                                Properties = new Dictionary<string, IOpenApiSchema>() {

                                Properties = new Dictionary<string, IOpenApiSchema>()

                                {

                                    ["firstName"] = new OpenApiSchema(),

                                    ["lastName"] = new OpenApiSchema()

                                }

                            },

                            new OpenApiSchema() {

                            new OpenApiSchema()

                            {

                                Type = JsonSchemaType.Object,

                                Properties = new Dictionary<string, IOpenApiSchema>() {

                                Properties = new Dictionary<string, IOpenApiSchema>()

                                {

                                    ["lastName"] = new OpenApiSchema()

                                }

                            },

    @@ -947,11 +967,11 @@ public void IsEnumFailsOnEmptyMembers()
  
            Enum =

                [

                "low",

                "medium",

                "high",

                "hidden",

                "none",

                "unknownFutureValue"

                    "medium",

                    "high",

                    "hidden",

                    "none",

                    "unknownFutureValue"

            ],

            Type = JsonSchemaType.String

        };

Fix empty objects in plugin manifests by omitting them instead of serializing empty {} #6945

Are you sure you want to change the base?

Uh oh!

Fix empty objects in plugin manifests by omitting them instead of serializing empty {} #6945

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

GitHub Actions / test-release (ubuntu-latest)

GitHub Actions / test-release (ubuntu-latest)

GitHub Actions / test-release (ubuntu-24.04-arm)

GitHub Actions / test-release (ubuntu-24.04-arm)

GitHub Actions / test-release (ubuntu-24.04-arm)

GitHub Actions / test-release (ubuntu-24.04-arm)

GitHub Actions / test-release (ubuntu-latest)

GitHub Actions / test-release (ubuntu-latest)

GitHub Actions / build

GitHub Actions / build

GitHub Actions / build

GitHub Actions / build

GitHub Actions / test_and_generate_binaries (linux-arm64, ubuntu-24.04-arm)

GitHub Actions / test_and_generate_binaries (linux-arm64, ubuntu-24.04-arm)

GitHub Actions / test-release (windows-latest)

GitHub Actions / test-release (windows-latest)

GitHub Actions / test_and_generate_binaries (linux-arm64, ubuntu-24.04-arm)

GitHub Actions / test_and_generate_binaries (linux-arm64, ubuntu-24.04-arm)

GitHub Actions / test_and_generate_binaries (linux-x64, ubuntu-latest)

GitHub Actions / test_and_generate_binaries (linux-x64, ubuntu-latest)

GitHub Actions / test_and_generate_binaries (linux-x64, ubuntu-latest)

GitHub Actions / test_and_generate_binaries (linux-x64, ubuntu-latest)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / test-release (windows-latest)

GitHub Actions / dotnet-build

GitHub Actions / test-release (windows-latest)

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / dotnet-build

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / Analyze (csharp)

GitHub Actions / test-release (windows-11-arm)

GitHub Actions / test-release (windows-11-arm)

GitHub Actions / test-release (windows-11-arm)

GitHub Actions / test-release (windows-11-arm)

GitHub Actions / test_and_generate_binaries (win-x64, windows-latest)

GitHub Actions / test_and_generate_binaries (win-x64, windows-latest)

GitHub Actions / test_and_generate_binaries (win-x64, windows-latest)

GitHub Actions / test_and_generate_binaries (win-x64, windows-latest)

GitHub Actions / test_and_generate_binaries (win-arm64, windows-11-arm)

GitHub Actions / test_and_generate_binaries (win-arm64, windows-11-arm)

GitHub Actions / test_and_generate_binaries (win-arm64, windows-11-arm)

GitHub Actions / test_and_generate_binaries (win-arm64, windows-11-arm)

GitHub Actions / test_and_generate_binaries (osx-arm64, macOS-latest)

GitHub Actions / test_and_generate_binaries (osx-arm64, macOS-latest)

GitHub Actions / test-release (macos-latest)

GitHub Actions / test-release (macos-latest)

GitHub Actions / test-release (macos-latest)

GitHub Actions / test-release (macos-latest)

GitHub Actions / test_and_generate_binaries (osx-arm64, macOS-latest)

GitHub Actions / test_and_generate_binaries (osx-arm64, macOS-latest)

GitHub Actions / test-release (ubuntu-latest)

GitHub Actions / test-release (ubuntu-latest)

GitHub Actions / test-release (ubuntu-24.04-arm)