Add remarks about when cluster_manager_timeout is supported

Signed-off-by: Thomas Farr <tsfarr@amazon.com>
opensearch-project · Aug 23, 2023 · 5b64ea6 · 5b64ea6
1 parent 41e7980
commit 5b64ea6
Show file tree

Hide file tree

Showing 10 changed files with 236 additions and 113 deletions.
diff --git a/src/ApiGenerator/Domain/Specification/QueryParameters.cs b/src/ApiGenerator/Domain/Specification/QueryParameters.cs
@@ -45,6 +45,8 @@ public class QueryParameters
 
         public string Description { get; set; }
 
+		public string VersionAdded { get; set; }
+
         public IEnumerable<string> DescriptionHighLevel
         {
             get
@@ -191,8 +193,8 @@ public string TypeLowLevel
         }
 
 
-        public string InitializerGenerator(string @namespace, string type, string name, string key, string setter, params string[] doc) =>
-            CodeGenerator.Property(@namespace, type, name, key, setter, Obsolete, doc);
+        public string InitializerGenerator(string @namespace, string type, string name, string key, string setter, string versionAdded, params string[] doc) =>
+            CodeGenerator.Property(@namespace, type, name, key, setter, Obsolete, versionAdded, doc);
     }
 
     public class QueryParameterDeprecation

diff --git a/src/ApiGenerator/Generator/ApiEndpointFactory.cs b/src/ApiGenerator/Generator/ApiEndpointFactory.cs
@@ -89,7 +89,8 @@ public static ApiEndpoint From(string name, List<(string HttpPath, OpenApiPathIt
 	                    Type = GetOpenSearchType(p.Schema),
 	                    Description = p.Description,
 	                    Options = GetEnumOptions(p.Schema),
-	                    Deprecated = GetDeprecation(p.Schema)
+	                    Deprecated = GetDeprecation(p.Schema),
+	                    VersionAdded = p.Schema.GetExtension("x-version-added") as string,
 	                });
 
 	        var endpoint = new ApiEndpoint

diff --git a/src/ApiGenerator/Generator/CodeGenerator.cs b/src/ApiGenerator/Generator/CodeGenerator.cs
@@ -45,10 +45,11 @@ public static string CatFormatPropertyGenerator(string type, string name, string
         public static string PropertyGenerator(string type, string name, string key, string setter) =>
             $"public {type} {name} {{ get => Q<{type}>(\"{key}\"); set => Q(\"{key}\", {setter}); }}";
 
-        public static string Property(string @namespace, string type, string name, string key, string setter, string obsolete, params string[] doc)
+        public static string Property(string @namespace, string type, string name, string key, string setter, string obsolete, string versionAdded, params string[] doc)
         {
             var components = new List<string>();
             foreach (var d in RenderDocumentation(doc)) A(d);
+			if (!string.IsNullOrWhiteSpace(versionAdded)) A($"///<remarks>Supported by OpenSearch servers of version {versionAdded} or greater.</remarks>");
             if (!string.IsNullOrWhiteSpace(obsolete)) A($"[Obsolete(\"{obsolete}\")]");
 
             var generated = @namespace != null && @namespace == "Cat" && name == "Format"

diff --git a/src/ApiGenerator/OpenSearch.openapi.json b/src/ApiGenerator/OpenSearch.openapi.json
diff --git a/src/ApiGenerator/Views/HighLevel/Descriptors/Descriptor.cshtml b/src/ApiGenerator/Views/HighLevel/Descriptors/Descriptor.cshtml
@@ -53,7 +53,14 @@
     var desc = param.DescriptionHighLevel.ToList();
 
     await IncludeAsync("HighLevel/Descriptors/XmlDocs.cshtml", desc);
-    if(!string.IsNullOrWhiteSpace(param.Obsolete))
+
+	if (!string.IsNullOrWhiteSpace(param.VersionAdded))
+	{
+		<text>
+		///<remarks>Supported by OpenSearch servers of version @(param.VersionAdded) or greater.</remarks></text>
+	}
+
+	if(!string.IsNullOrWhiteSpace(param.Obsolete))
     {
         <text>
         [Obsolete("@Raw(param.Obsolete)")]

diff --git a/src/ApiGenerator/Views/HighLevel/Requests/RequestImplementations.cshtml b/src/ApiGenerator/Views/HighLevel/Requests/RequestImplementations.cshtml
@@ -57,7 +57,7 @@
         continue;
     }
     var doc = param.DescriptionHighLevel.ToArray();
-	@Raw(param.InitializerGenerator(Model.CsharpNames.Namespace, param.TypeHighLevel, param.ClsName, original, param.SetterHighLevel, doc))
+	@Raw(param.InitializerGenerator(Model.CsharpNames.Namespace, param.TypeHighLevel, param.ClsName, original, param.SetterHighLevel, param.VersionAdded, doc))
 }
 @if (Model.CsharpNames.DescriptorNotFoundInCodebase)
 {<text>

diff --git a/src/ApiGenerator/Views/LowLevel/RequestParameters/RequestParameters.cshtml b/src/ApiGenerator/Views/LowLevel/RequestParameters/RequestParameters.cshtml
@@ -32,7 +32,7 @@ namespace OpenSearch.Net@(ns)
         public override bool SupportsBody => @(supportsBody ? "true" : "false");
         @foreach (var param in r.Params)
         {
-<text>      @Raw(param.InitializerGenerator(r.CsharpNames.Namespace, param.TypeLowLevel, param.ClsName, param.QueryStringKey, param.SetterLowLevel, param.Description))
+<text>      @Raw(param.InitializerGenerator(r.CsharpNames.Namespace, param.TypeLowLevel, param.ClsName, param.QueryStringKey, param.SetterLowLevel, param.VersionAdded, param.Description))
 </text>
         }
     }</text>

diff --git a/src/OpenSearch.Client/_Generated/Descriptors.DanglingIndices.cs b/src/OpenSearch.Client/_Generated/Descriptors.DanglingIndices.cs
@@ -89,6 +89,7 @@ public DeleteDanglingIndexDescriptor AcceptDataLoss(bool? acceptdataloss = true)
             Qs("accept_data_loss", acceptdataloss);
 
         ///<summary>Operation timeout for connection to cluster-manager node.</summary>
+        ///<remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
         public DeleteDanglingIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
             Qs("cluster_manager_timeout", clustermanagertimeout);
 
@@ -134,6 +135,7 @@ public ImportDanglingIndexDescriptor AcceptDataLoss(bool? acceptdataloss = true)
             Qs("accept_data_loss", acceptdataloss);
 
         ///<summary>Operation timeout for connection to cluster-manager node.</summary>
+        ///<remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
         public ImportDanglingIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
             Qs("cluster_manager_timeout", clustermanagertimeout);
 

diff --git a/src/OpenSearch.Client/_Generated/Requests.DanglingIndices.cs b/src/OpenSearch.Client/_Generated/Requests.DanglingIndices.cs
@@ -98,6 +98,7 @@ public bool? AcceptDataLoss
         }
 
         ///<summary>Operation timeout for connection to cluster-manager node.</summary>
+        ///<remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
         public Time ClusterManagerTimeout
         {
             get => Q<Time>("cluster_manager_timeout");
@@ -162,6 +163,7 @@ public bool? AcceptDataLoss
         }
 
         ///<summary>Operation timeout for connection to cluster-manager node.</summary>
+        ///<remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
         public Time ClusterManagerTimeout
         {
             get => Q<Time>("cluster_manager_timeout");

diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.DanglingIndices.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.DanglingIndices.cs
@@ -67,6 +67,7 @@ public bool? AcceptDataLoss
         }
 
         ///<summary>Operation timeout for connection to cluster-manager node.</summary>
+        ///<remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
         public TimeSpan ClusterManagerTimeout
         {
             get => Q<TimeSpan>("cluster_manager_timeout");
@@ -106,6 +107,7 @@ public bool? AcceptDataLoss
         }
 
         ///<summary>Operation timeout for connection to cluster-manager node.</summary>
+        ///<remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
         public TimeSpan ClusterManagerTimeout
         {
             get => Q<TimeSpan>("cluster_manager_timeout");