comments

Author: lucashuet93

src/APIM_ARMTemplate/apimtemplate/Creator/ExampleFiles/YAMLConfigs/valid.yml

@@ -1,13 +1,13 @@
 version: 0.0.1   # Required
-apimServiceName: LucasUnlinked2   # Required, must match name of an apim service deployed in the specified resource group
+apimServiceName: Lucas2   # Required, must match name of an apim service deployed in the specified resource group
 apiVersionSet:   # Optional
-    displayName: swaggerPetstoreVersionSet
+    displayName: swaggerPetstoreVersionSetLinked
     description: a description
     versioningScheme: Query
     versionQueryName: versionQuery
     versionHeaderName: versionHeader
 api:
-  name: myAPI2   # Required
+  name: myUnlinkedAPI   # Required
   openApiSpec: C:\Users\lucashh\Desktop\Projects\APIM-ARM\azure-api-management-devops-example\src\APIM_ARMTemplate\apimtemplate\Creator\ExampleFiles\OpenApiSpecs\swaggerPetstore.json    # Required, can be url or local file
   policy: C:\Users\lucashh\Desktop\Projects\APIM-ARM\azure-api-management-devops-example\src\APIM_ARMTemplate\apimtemplate\Creator\ExampleFiles\XMLPolicies\apiPolicyHeaders.xml   # Optional, can be url or local file
   suffix: conf   # Required
@@ -23,5 +23,5 @@ api:
       policy: C:\Users\lucashh\Desktop\Projects\APIM-ARM\azure-api-management-devops-example\src\APIM_ARMTemplate\apimtemplate\Creator\ExampleFiles\XMLPolicies\operationRateLimit.xml   # Optional, can be url or local file
   products: starter, platinum    # Optional, adds api to the specified products
 outputLocation: C:\Users\lucashh\Desktop\Projects\APIM-ARM\GeneratedTemplates   # Required, folder the creator will write the templates to
-linked: false   # Optional
+linked: true   # Optional
 linkedTemplatesBaseUrl : https://lucasyamlblob.blob.core.windows.net/yaml   # Required if 'linked' property is set to true

src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APITemplateCreator.cs

@@ -32,7 +32,7 @@ public async Task<Template> CreateInitialAPITemplateAsync(CreatorConfig creatorC
             };
 
             List<TemplateResource> resources = new List<TemplateResource>();
-            // create api resource with properties
+            // create api resource w/ metadata
             APITemplateResource initialAPITemplateResource = await this.CreateInitialAPITemplateResource(creatorConfig);
             resources.Add(initialAPITemplateResource);
 
@@ -55,7 +55,7 @@ public async Task<Template> CreateSubsequentAPITemplateAsync(CreatorConfig creat
             string[] dependsOnSubsequentAPI = new string[] { $"[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), '{apiName}')]" };
 
             List<TemplateResource> resources = new List<TemplateResource>();
-            // create api resource with properties
+            // create api resource w/ swagger content and policies
             APITemplateResource subsequentAPITemplateResource = await this.CreateSubsequentAPITemplateResourceAsync(creatorConfig);
             PolicyTemplateResource apiPolicyResource = await this.policyTemplateCreator.CreateAPIPolicyTemplateResourceAsync(creatorConfig, dependsOnSubsequentAPI);
             List<PolicyTemplateResource> operationPolicyResources = await this.policyTemplateCreator.CreateOperationPolicyTemplateResourcesAsync(creatorConfig, dependsOnSubsequentAPI);
@@ -96,7 +96,7 @@ public async Task<APITemplateResource> CreateInitialAPITemplateResource(CreatorC
                 // if the template is not linked the depends on for the apiVersionSet needs to be inlined here
                 dependsOn = new string[] { }
             };
-            // if there is a linked template and a version set was created, the initial api depends on it
+            // if the template is linked and a version set was created, the initial api depends on it
             if (creatorConfig.linked == false && creatorConfig.apiVersionSet != null)
             {
                 apiTemplateResource.dependsOn = new string[] { $"[resourceId('Microsoft.ApiManagement/service/api-version-sets', parameters('ApimServiceName'), 'versionset')]" };
@@ -139,6 +139,7 @@ public async Task<APITemplateResource> CreateSubsequentAPITemplateResourceAsync(
 
         public string[] CreateProtocols(OpenApiDocument doc)
         {
+            // pull protocols from swagger OpenApiDocument
             List<string> protocols = new List<string>();
             foreach (OpenApiServer server in doc.Servers)
             {

src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/MasterTemplateCreator.cs

@@ -29,17 +29,17 @@ public Template CreateLinkedMasterTemplate(Template apiVersionSetTemplate,
             if (apiVersionSetTemplate != null)
             {
                 string apiVersionSetUri = $"[concat(parameters('LinkedTemplatesBaseUrl'), '{creatorFileNames.apiVersionSet}')]";
-                resources.Add(this.CreateMasterTemplateResource("versionSetTemplate", apiVersionSetUri, new string[] { }));
+                resources.Add(this.CreateLinkedMasterTemplateResource("versionSetTemplate", apiVersionSetUri, new string[] { }));
             }
 
             //api
             string initialAPIUri = $"[concat(parameters('LinkedTemplatesBaseUrl'), '{creatorFileNames.initialAPI}')]";
             string[] initialAPIDependsOn = apiVersionSetTemplate != null ? new string[] { "[resourceId('Microsoft.Resources/deployments', 'versionSetTemplate')]" } : new string[] { };
-            resources.Add(this.CreateMasterTemplateResource("initialAPITemplate", initialAPIUri, initialAPIDependsOn));
+            resources.Add(this.CreateLinkedMasterTemplateResource("initialAPITemplate", initialAPIUri, initialAPIDependsOn));
 
             string subsequentAPIUri = $"[concat(parameters('LinkedTemplatesBaseUrl'), '{creatorFileNames.subsequentAPI}')]";
             string[] subsequentAPIDependsOn = apiVersionSetTemplate != null ? new string[] { "[resourceId('Microsoft.Resources/deployments', 'initialAPITemplate')]" } : new string[] { };
-            resources.Add(this.CreateMasterTemplateResource("subsequentAPITemplate", subsequentAPIUri, subsequentAPIDependsOn));
+            resources.Add(this.CreateLinkedMasterTemplateResource("subsequentAPITemplate", subsequentAPIUri, subsequentAPIDependsOn));
 
             masterTemplate.resources = resources.ToArray();
             return masterTemplate;
@@ -88,7 +88,7 @@ public Template CreateSubsequentUnlinkedMasterTemplate(Template subequentAPITemp
             return masterTemplate;
         }
 
-        public MasterTemplateResource CreateMasterTemplateResource(string name, string uriLink, string[] dependsOn)
+        public MasterTemplateResource CreateLinkedMasterTemplateResource(string name, string uriLink, string[] dependsOn)
         {
             MasterTemplateResource masterTemplateResource = new MasterTemplateResource()
             {
@@ -116,6 +116,7 @@ public MasterTemplateResource CreateMasterTemplateResource(string name, string u
         public Dictionary<string, TemplateParameterProperties> CreateMasterTemplateParameters(bool linked)
         {
             // used to create the parameter metatadata, etc (not value) for use in file with resources
+            // add parameters with metatdata properties
             Dictionary<string, TemplateParameterProperties> parameters = new Dictionary<string, TemplateParameterProperties>();
             TemplateParameterProperties apimServiceNameProperties = new TemplateParameterProperties()
             {
@@ -147,7 +148,7 @@ public Template CreateMasterTemplateParameterValues(CreatorConfig creatorConfig)
             // create empty template
             Template masterTemplate = this.templateCreator.CreateEmptyTemplate();
 
-            // add parameters
+            // add parameters with value property
             Dictionary<string, TemplateParameterProperties> parameters = new Dictionary<string, TemplateParameterProperties>();
             TemplateParameterProperties apimServiceNameProperties = new TemplateParameterProperties()
             {