Re-generate nodes namespace (#352)

* Use specification naming for enums Signed-off-by: Thomas Farr <[email protected]> * Handle deprecated paths Signed-off-by: Thomas Farr <[email protected]> * Re-generate `nodes.hot_threads` Signed-off-by: Thomas Farr <[email protected]> * Handle overloaded param Signed-off-by: Thomas Farr <[email protected]> * Better sorting Signed-off-by: Thomas Farr <[email protected]> * Re-generate `nodes.info` Signed-off-by: Thomas Farr <[email protected]> * Re-generate `nodes.reload_secure_settings` Signed-off-by: Thomas Farr <[email protected]> * Sort URL parts Signed-off-by: Thomas Farr <[email protected]> * Re-generate `nodes.stats` Signed-off-by: Thomas Farr <[email protected]> * Correctly handle URL part enum options Signed-off-by: Thomas Farr <[email protected]> * Make ApiUrls readonly Signed-off-by: Thomas Farr <[email protected]> * Re-generate `nodes.usage` Signed-off-by: Thomas Farr <[email protected]> --------- Signed-off-by: Thomas Farr <[email protected]>
opensearch-project · Sep 7, 2023 · 4c47670 · 4c47670
1 parent 077d705
commit 4c47670
Show file tree

Hide file tree

Showing 34 changed files with 2,461 additions and 1,777 deletions.
diff --git a/src/ApiGenerator/Configuration/CodeConfiguration.cs b/src/ApiGenerator/Configuration/CodeConfiguration.cs
@@ -39,9 +39,9 @@ public static class CodeConfiguration
 	{
 		private static readonly Glob[] OperationsToInclude =
 		{
-			// e.g. new Glob("nodes.*"),
 			new("dangling_indices.*"),
 			new("ingest.*"),
+            new("nodes.*"),
 			new("snapshot.*"),
 			new("tasks.*")
 		};

diff --git a/src/ApiGenerator/Configuration/Overrides/Endpoints/NodesHotThreadsOverrides.cs b/src/ApiGenerator/Configuration/Overrides/Endpoints/NodesHotThreadsOverrides.cs
diff --git a/src/ApiGenerator/Domain/ApiQueryParametersPatcher.cs b/src/ApiGenerator/Domain/ApiQueryParametersPatcher.cs
@@ -58,7 +58,8 @@ IEndpointOverrides overrides
 				value.QueryStringKey = queryStringKey;
 
                 if (!renameLookup.TryGetValue(queryStringKey, out var preferredName)) preferredName = queryStringKey;
-                value.ClsName = CreateCSharpName(preferredName, endpointName);
+
+                value.ClsName ??= CreateCSharpName(preferredName, endpointName);
 
                 if (skipList.Contains(queryStringKey)) value.Skip = true;
 

diff --git a/src/ApiGenerator/Domain/RestApiSpec.cs b/src/ApiGenerator/Domain/RestApiSpec.cs
@@ -43,7 +43,7 @@ public class EnumDescription
 
     public class RestApiSpec
     {
-		public IDictionary<string, ApiEndpoint> Endpoints { get; set; }
+		public ImmutableSortedDictionary<string, ApiEndpoint> Endpoints { get; set; }
 
         public ImmutableSortedDictionary<string, ReadOnlyCollection<ApiEndpoint>> EndpointsPerNamespaceLowLevel =>
             Endpoints.Values.GroupBy(e=>e.CsharpNames.Namespace)
@@ -63,44 +63,32 @@ public IEnumerable<EnumDescription> EnumsInTheSpec
             {
                 if (_enumDescriptions != null) return _enumDescriptions;
 
-                string CreateName(string name, string methodName, string @namespace)
-                {
-                    if (
-                        name.ToLowerInvariant().Contains("metric")
-                         ||(name.ToLowerInvariant() == "status")
-                         ||(name.ToLowerInvariant() == "format")
-                    )
-                    {
-                        if (methodName.StartsWith(@namespace))
-                            return methodName + name;
-                        else
-                            return @namespace + methodName + name;
-                    }
+                var urlParameterEnums = Endpoints
+					.Values
+					.SelectMany(e => e.Url.Params.Values)
+					.Where(p => p.Options != null && p.Options.Any())
+					.Select(p => new EnumDescription
+					{
+						Name = p.ClsName,
+						Options = p.Options
+					})
+					.ToList();
 
-                    return name;
-                }
-
-                var urlParameterEnums = (
-                    from e in Endpoints.Values
-                    from para in e.Url.Params.Values
-                    where para.Options != null && para.Options.Any()
-                    let name = CreateName(para.ClsName, e.CsharpNames.MethodName, e.CsharpNames.Namespace)
-                    where name != "Time"
-                    select new EnumDescription
-                    {
-                        Name = name,
-                        Options = para.Options
-                    }).ToList();
-
-                var urlPartEnums = (
-                    from e in Endpoints.Values
-                    from part in e.Url.Parts
-                    where part.Options != null && part.Options.Any()
-                    select new EnumDescription
-                    {
-                        Name = CreateName(part.Name.ToPascalCase(), e.CsharpNames.MethodName, e.CsharpNames.Namespace),
-                        Options = part.Options
-                    }).ToList();
+                var urlPartEnums = Endpoints
+					.Values
+					.SelectMany(e => e.Url.Parts, (e, part) => new { e, part })
+					.Where(p => p.part.Options != null && p.part.Options.Any())
+					.Select(p =>
+					{
+						var ns = p.e.CsharpNames.Namespace;
+						var m = p.e.CsharpNames.MethodName;
+						return new EnumDescription
+						{
+							Name = (!m.StartsWith(ns) ? ns : string.Empty) + m + p.part.Name.ToPascalCase(),
+							Options = p.part.Options
+						};
+					}).
+					ToList();
 
                 _enumDescriptions = urlPartEnums
                     .Concat(urlParameterEnums)

diff --git a/src/ApiGenerator/Domain/Specification/ApiEndpoint.cs b/src/ApiGenerator/Domain/Specification/ApiEndpoint.cs
@@ -62,44 +62,46 @@ public class ApiEndpoint
 
         public IEndpointOverrides Overrides { get; internal set; }
 
-        public RequestInterface RequestInterface => new RequestInterface
-        {
+		private IEnumerable<QueryParameters> ParamsToGenerate => Url.Params.Values.Where(p => !p.Skip).OrderBy(p => p.ClsName);
+
+        public RequestInterface RequestInterface => new()
+		{
             CsharpNames = CsharpNames,
             UrlParts = Url.Parts,
             PartialParameters =
-                Body == null ? Enumerable.Empty<QueryParameters>().ToList() : Url.Params.Values.Where(p => p.RenderPartial && !p.Skip).ToList(),
+                Body == null ? Enumerable.Empty<QueryParameters>().ToList() : ParamsToGenerate.Where(p => p.RenderPartial).ToList(),
             OfficialDocumentationLink = OfficialDocumentationLink?.Url
         };
 
-        public RequestPartialImplementation RequestPartialImplementation => new RequestPartialImplementation
-        {
+        public RequestPartialImplementation RequestPartialImplementation => new()
+		{
             CsharpNames = CsharpNames,
             OfficialDocumentationLink = OfficialDocumentationLink?.Url,
             Stability = Stability,
             Paths = Url.Paths,
             Parts = Url.Parts,
-            Params = Url.Params.Values.Where(p => !p.Skip).ToList(),
+            Params = ParamsToGenerate.ToList(),
             Constructors = Constructor.RequestConstructors(CsharpNames, Url, inheritsFromPlainRequestBase: true).ToList(),
             GenericConstructors = Constructor.RequestConstructors(CsharpNames, Url, inheritsFromPlainRequestBase: false).ToList(),
             HasBody = Body != null,
         };
 
-        public DescriptorPartialImplementation DescriptorPartialImplementation => new DescriptorPartialImplementation
-        {
+        public DescriptorPartialImplementation DescriptorPartialImplementation => new()
+		{
             CsharpNames = CsharpNames,
             OfficialDocumentationLink = OfficialDocumentationLink?.Url,
             Constructors = Constructor.DescriptorConstructors(CsharpNames, Url).ToList(),
             Paths = Url.Paths,
             Parts = Url.Parts,
-            Params = Url.Params.Values.Where(p => !p.Skip).ToList(),
+            Params = ParamsToGenerate.ToList(),
             HasBody = Body != null,
         };
 
-        public RequestParameterImplementation RequestParameterImplementation => new RequestParameterImplementation
-        {
+        public RequestParameterImplementation RequestParameterImplementation => new()
+		{
             CsharpNames = CsharpNames,
             OfficialDocumentationLink = OfficialDocumentationLink?.Url,
-            Params = Url.Params.Values.Where(p => !p.Skip).ToList(),
+            Params = ParamsToGenerate.ToList(),
             HttpMethod = PreferredHttpMethod
         };
 

diff --git a/src/ApiGenerator/Domain/Specification/UrlInformation.cs b/src/ApiGenerator/Domain/Specification/UrlInformation.cs
@@ -28,6 +28,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.Linq;
 
 namespace ApiGenerator.Domain.Specification
@@ -42,7 +43,7 @@ public class UrlInformation
 
         public IDictionary<string, UrlPart> OriginalParts { get; set; }
 
-        private IReadOnlyCollection<DeprecatedPath> DeprecatedPaths { get; set; }
+        public IList<DeprecatedPath> DeprecatedPaths { get; set; } = new List<DeprecatedPath>();
 
         private List<UrlPath> _paths;
         public IReadOnlyCollection<UrlPath> Paths
@@ -113,7 +114,11 @@ public IReadOnlyCollection<UrlPath> PathsWithDeprecations
         }
 
 
-        public IReadOnlyCollection<UrlPart> Parts => Paths.SelectMany(p => p.Parts).DistinctBy(p => p.Name).ToList();
+        public IReadOnlyCollection<UrlPart> Parts => Paths
+				.SelectMany(p => p.Parts)
+				.DistinctBy(p => p.Name)
+				.OrderBy(p => p.Name)
+				.ToList();
 
         public bool IsPartless => !Parts.Any();
 
@@ -135,6 +140,5 @@ public bool TryGetDocumentApiPath(out UrlPath path)
             path = new UrlPath(mostVerbosePath.Path, OriginalParts, mostVerbosePath.Parts);
             return true;
         }
-
     }
 }
diff --git a/src/ApiGenerator/Generator/ApiEndpointFactory.cs b/src/ApiGenerator/Generator/ApiEndpointFactory.cs
@@ -37,6 +37,7 @@
 using ApiGenerator.Domain.Code;
 using ApiGenerator.Domain.Specification;
 using NJsonSchema;
+using NJsonSchema.References;
 using NSwag;
 
 namespace ApiGenerator.Generator
@@ -55,16 +56,37 @@ public static ApiEndpoint From(string name, List<(string HttpPath, OpenApiPathIt
 
 	        foreach (var (httpPath, path, _, operation) in variants.DistinctBy(v => v.HttpPath))
 	        {
-	            urlInfo.OriginalPaths.Add(httpPath);
+	            if (!operation.IsDeprecated)
+                    urlInfo.OriginalPaths.Add(httpPath);
+                else
+                {
+                    urlInfo.DeprecatedPaths.Add(new DeprecatedPath
+                    {
+                        Path = httpPath,
+                        Version = operation.GetExtension("x-version-deprecated") as string,
+                        Description = operation.GetExtension("x-deprecation-message") as string
+                    });
+                }
+
 	            var pathParams = path.Parameters
 	                .Concat(operation.Parameters)
 	                .Where(p => p.Kind == OpenApiParameterKind.Path)
 	                .ToList();
+
+				foreach (var overloadedParam in pathParams.Where(p => p.Schema.XOverloadedParam() != null))
+				{
+					urlInfo.OriginalPaths.Add(httpPath.Replace(
+						$"{{{overloadedParam.Name}}}",
+						$"{{{overloadedParam.Schema.XOverloadedParam()}}}"
+					));
+				}
+
 	            var paramNames = pathParams.Select(p => p.Name);
-	            if (requiredPathParams != null)
+				if (requiredPathParams != null)
 	                requiredPathParams.IntersectWith(paramNames);
 	            else
 	                requiredPathParams = new HashSet<string>(paramNames);
+
 	            allPathParams.AddRange(pathParams);
 	        }
 
@@ -84,15 +106,7 @@ public static ApiEndpoint From(string name, List<(string HttpPath, OpenApiPathIt
 	        urlInfo.Params = variants.SelectMany(v => v.Path.Parameters.Concat(v.Operation.Parameters))
 	            .Where(p => p.Kind == OpenApiParameterKind.Query)
 	            .DistinctBy(p => p.Name)
-	            .ToImmutableSortedDictionary(p => p.Name,
-	                p => new QueryParameters
-	                {
-	                    Type = GetOpenSearchType(p.Schema),
-	                    Description = p.Description,
-	                    Options = GetEnumOptions(p.Schema),
-	                    Deprecated = GetDeprecation(p.Schema),
-	                    VersionAdded = p.Schema.XVersionAdded()
-	                });
+	            .ToImmutableSortedDictionary(p => p.Name, BuildQueryParam);
 
 	        var endpoint = new ApiEndpoint
 	        {
@@ -138,6 +152,25 @@ private static void PatchRequestParameters(ApiEndpoint endpoint) =>
 	        endpoint.Url.Params = ApiQueryParametersPatcher.Patch(endpoint.Name, endpoint.Url.Params, endpoint.Overrides)
 	            ?? throw new ArgumentNullException("ApiQueryParametersPatcher.Patch(endpoint.Name, endpoint.Url.Params, endpoint.Overrides)");
 
+        private static QueryParameters BuildQueryParam(OpenApiParameter p)
+        {
+            var param = new QueryParameters
+            {
+                Type = GetOpenSearchType(p.Schema),
+                Description = p.Description,
+                Options = GetEnumOptions(p.Schema),
+                Deprecated = GetDeprecation(p.Schema),
+                VersionAdded = p.Schema.XVersionAdded(),
+            };
+
+            if (param.Type == "enum" && p.Schema.HasReference)
+            {
+                param.ClsName = ((IJsonReference)p.Schema).ReferencePath.Split('/').Last();
+            }
+
+            return param;
+        }
+
 	    private static string GetOpenSearchType(JsonSchema schema)
 		{
 			schema = schema.ActualSchema;
@@ -155,7 +188,9 @@ private static string GetOpenSearchType(JsonSchema schema)
 	    }
 
 	    private static IEnumerable<string> GetEnumOptions(JsonSchema schema) =>
-			schema.ActualSchema.Enumeration?.Select(e => e.ToString()) ?? Enumerable.Empty<string>();
+			schema.ActualSchema.XEnumOptions()
+			?? schema.ActualSchema.Enumeration?.Select(e => e.ToString())
+			?? Enumerable.Empty<string>();
 
 		private static QueryParameterDeprecation GetDeprecation(IJsonExtensionObject schema) =>
 			(schema.XDeprecationMessage(), schema.XVersionDeprecated()) switch
@@ -186,6 +221,12 @@ private static string XVersionAdded(this IJsonExtensionObject schema) =>
 		private static string XDataType(this IJsonExtensionObject schema) =>
 			schema.GetExtension("x-data-type") as string;
 
+		private static string XOverloadedParam(this IJsonExtensionObject schema) =>
+			schema.GetExtension("x-overloaded-param") as string;
+
+		private static IEnumerable<string> XEnumOptions(this IJsonExtensionObject schema) =>
+			schema.GetExtension("x-enum-options") is object[] opts ? opts.Cast<string>() : null;
+
 	    private static object GetExtension(this IJsonExtensionObject schema, string key) =>
 	        schema.ExtensionData?.TryGetValue(key, out var value) ?? false ? value : null;
 	}

diff --git a/src/ApiGenerator/Generator/ApiGenerator.cs b/src/ApiGenerator/Generator/ApiGenerator.cs
@@ -36,6 +36,7 @@
 using ApiGenerator.Configuration;
 using ApiGenerator.Domain;
 using ApiGenerator.Generator.Razor;
+using NJsonSchema;
 using NSwag;
 using ShellProgressBar;
 
@@ -92,6 +93,7 @@ await DoGenerate(
 		public static async Task<RestApiSpec> CreateRestApiSpecModel(CancellationToken token = default)
 		{
 			var document = await OpenApiYamlDocument.FromFileAsync(GeneratorLocations.OpenApiSpecFile, token);
+            JsonSchemaReferenceUtilities.UpdateSchemaReferencePaths(document);
 
 			var endpoints = document.Paths
 				.Select(kv => new { HttpPath = kv.Key, PathItem = kv.Value })