Add parameterExampleContract definition for API request/response Models (#706)

Co-authored-by: Farhad Alizada <falizada@microsoft.com>

Author: f-alizada

src/ArmTemplates/Common/Templates/ApiOperations/ApiOperationRepresentation.cs

@@ -2,6 +2,7 @@
 //  Copyright (c) Microsoft Corporation. All rights reserved.
 //  Licensed under the MIT License.
 // --------------------------------------------------------------------------
+using System.Collections.Generic;
 
 namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.ApiOperations
 {
@@ -14,5 +15,7 @@ public class ApiOperationRepresentation
         public string TypeName { get; set; }
 
         public string Sample { get; set; }
+
+        public IDictionary<string, ParameterExampleContract> Examples { get; set; }
     }
 }

src/ArmTemplates/Common/Templates/ApiOperations/ParameterExampleContract.cs

@@ -0,0 +1,18 @@
+// --------------------------------------------------------------------------
+//  Copyright (c) Microsoft Corporation. All rights reserved.
+//  Licensed under the MIT License.
+// --------------------------------------------------------------------------
+
+namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common.Templates.ApiOperations
+{
+    public class ParameterExampleContract
+    {
+        public string Description { get; set; }
+
+        public string ExternalValue { get; set; }
+
+        public string Summary { get; set; }
+
+        public object Value { get; set; }
+    }
+}

tests/ArmTemplates.Tests/Extractor/Scenarios/ApiExtractorTests.cs

@@ -125,6 +125,10 @@ public async Task GenerateApiTemplates_ProperlyLaysTheInformation()
             apiTemplate.TypedResources.ApiOperations.All(x => x.Properties is not null).Should().BeTrue();
             apiTemplate.TypedResources.ApiOperations.SelectMany(x => x.DependsOn).Any(x => x.Contains($"'{ResourceTypeConstants.API}'")).Should().BeTrue();
             apiTemplate.TypedResources.ApiOperations.SelectMany(x => x.DependsOn).Any(x => x.Contains($"'{ResourceTypeConstants.APIOperation}'")).Should().BeFalse();
+            apiTemplate.TypedResources.ApiOperations.All(x => x.Properties.Request.Representations.Count() == 1).Should().BeTrue();
+            apiTemplate.TypedResources.ApiOperations.All(x => x.Properties.Responses.Count() == 1).Should().BeTrue();
+            apiTemplate.TypedResources.ApiOperations.All(x => x.Properties.Request.Representations.All(o => o.Examples.Count > 0)).Should().BeTrue();
+            apiTemplate.TypedResources.ApiOperations.All(x => x.Properties.Request.Representations.All(o => o.Examples.ContainsKey("default"))).Should().BeTrue();
 
             // api operations policies
             apiTemplate.TypedResources.ApiOperationsPolicies.Count().Should().Be(2);

tests/ArmTemplates.Tests/Moqs/ApiClients/MockApiOperationClient.cs

@@ -46,7 +46,10 @@ public class MockApiOperationClient
                 {
                     ContentType = "application/json",
                     SchemaId = "api-operation-representation-schema-id",
-                    TypeName = "api-operation-representation-type-name"
+                    TypeName = "api-operation-representation-type-name",
+                    Examples = new Dictionary<string, ParameterExampleContract>() {
+                        {"default", new ParameterExampleContract { Description = "description", Value = new object(), Summary = "summary" } }
+                    }
                 }
             }
         };
@@ -70,7 +73,11 @@ public class MockApiOperationClient
                 {
                     ContentType = "application/json",
                     SchemaId = "api-operation-representation-schema-id",
-                    TypeName = "api-operation-representation-type-name"
+                    TypeName = "api-operation-representation-type-name",
+                    Examples = new Dictionary<string, ParameterExampleContract>() {
+                        {"default", new ParameterExampleContract { Description = "description", Value = "plain value", Summary = "summary" } },
+                        {"not default", new ParameterExampleContract { Description = "description", Value = new object(), Summary = "summary" } }
+                    }
                 }
             }
         };

tests/ArmTemplates.Tests/Moqs/ApiClients/MockApisClient.cs

@@ -85,14 +85,23 @@ public static IApisClient GetMockedApiClientWithDefaultValues()
                 });
 
             mockServiceApiProductsApiClient
-                .Setup(x => x.GetSingleAsync(It.IsAny<string>(), It.IsAny<ExtractorParameters>()))
+                .Setup(x => x.GetSingleAsync(It.Is<string>((o => o.Equals(ServiceApiName1))), It.IsAny<ExtractorParameters>()))
                 .ReturnsAsync(new ApiTemplateResource
                 {
                     Name = ServiceApiName1,
                     Type = TemplateType,
                     Properties = ServiceApiProperties1
                 });
 
+            mockServiceApiProductsApiClient
+                .Setup(x => x.GetSingleAsync(It.Is<string>((o => o.Equals(ServiceApiName2))), It.IsAny<ExtractorParameters>()))
+                .ReturnsAsync(new ApiTemplateResource
+                {
+                    Name = ServiceApiName2,
+                    Type = TemplateType,
+                    Properties = ServiceApiProperties2
+                });
+
 
 
             mockServiceApiProductsApiClient