Added DisplaySettings property to VariablePromptOptions.

See OctopusDeploy/Issues#4531
OctopusDeploy · Jun 4, 2018 · 0dbe452 · 0dbe452
1 parent 7a22c4f
commit 0dbe452
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/...Tests/PublicSurfaceAreaFixture.ThePublicSurfaceAreaShouldNotRegress..NETCore.approved.txt b/...Tests/PublicSurfaceAreaFixture.ThePublicSurfaceAreaShouldNotRegress..NETCore.approved.txt
@@ -3389,6 +3389,7 @@ Octopus.Client.Model
   {
     .ctor()
     String Description { get; set; }
+    IDictionary<String, String> DisplaySettings { get; set; }
     String Label { get; set; }
     Boolean Required { get; set; }
     Octopus.Client.Model.VariablePromptOptions Clone()

diff --git a/.../PublicSurfaceAreaFixture.ThePublicSurfaceAreaShouldNotRegress..NETFramework.approved.txt b/.../PublicSurfaceAreaFixture.ThePublicSurfaceAreaShouldNotRegress..NETFramework.approved.txt
@@ -3867,6 +3867,7 @@ Octopus.Client.Model
   {
     .ctor()
     String Description { get; set; }
+    IDictionary<String, String> DisplaySettings { get; set; }
     String Label { get; set; }
     Boolean Required { get; set; }
     Octopus.Client.Model.VariablePromptOptions Clone()

diff --git a/source/Octopus.Client/Model/VariablePromptOptions.cs b/source/Octopus.Client/Model/VariablePromptOptions.cs
@@ -1,20 +1,34 @@
 using System;
+using System.Collections.Generic;
 
 namespace Octopus.Client.Model
 {
     public class VariablePromptOptions
     {
+        public VariablePromptOptions()
+        {
+            DisplaySettings = new Dictionary<string, string>();
+        }
+
         public string Label { get; set; }
         public string Description { get; set; }
         public bool Required { get; set; }
+
+        /// <summary>
+        /// Display options for the prompted-variable input UI.
+        /// Use key "Octopus.ControlType" to set the control-type <see cref="Octopus.Client.Model.ControlType"/>
+        /// Use key "Octopus.SelectOptions" to add select-options when control-type == "Select".
+        /// </summary>
+        public IDictionary<string, string> DisplaySettings { get; set; }
 
         public VariablePromptOptions Clone()
         {
             return new VariablePromptOptions
             {
                 Label = Label,
                 Description = Description,
-                Required = Required
+                Required = Required,
+                DisplaySettings = DisplaySettings
             };
         }
     }