Basic URL skipping (#5851) (#5853)

Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>

Author: github-actions[bot]

src/ApiGenerator/Configuration/SkippedUrls.cs

@@ -0,0 +1,13 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+using System.Collections.Generic;
+
+namespace ApiGenerator.Configuration
+{
+	public static class GeneralSkipList
+	{
+		public static IReadOnlyCollection<string> SkippedUrls => new[] { "/_search/scroll/{scroll_id}" };
+	}
+}

src/ApiGenerator/Domain/Code/HighLevel/Requests/Constructor.cs

@@ -47,10 +47,7 @@ string generic
 		{
 			var ctors = new List<Constructor>();
 
-			// Include deprecated paths to ensure these are not removed (a breaking change) during 7.x releases.
-			// For historical reasons, constructors for deprecated paths which specified a type where removed in 7.0 and
-			// therefore we don't include those in generation to avoid them being re-added.
-			var paths = url.Paths.ToList().Union(url.PathsWithDeprecations.Where(x => x.Parts.All(p => p.Name != "type")));
+			var paths = url.FinalPaths;
 
 			if (url.IsPartless) return ctors;
 
@@ -100,13 +97,15 @@ string generic
 			}
 			var constructors = ctors.GroupBy(c => c.Generated.Split(new[] { ':' }, 2)[0]).Select(g => g.Last()).ToList();
 			if (!constructors.Any(c => c.Parameterless))
+			{
 				constructors.Add(new Constructor
 				{
 					Parameterless = true,
 					Generated = $"protected {typeName}() : base()",
 					Description =
 						$"///<summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>{Indent}[SerializationConstructor]",
 				});
+			}
 			return constructors;
 		}
 	}

src/ApiGenerator/Domain/Specification/ApiEndpoint.cs

@@ -28,7 +28,7 @@ public class ApiEndpoint
 			CsharpNames = CsharpNames,
 			OfficialDocumentationLink = OfficialDocumentationLink?.Url,
 			Constructors = Constructor.DescriptorConstructors(CsharpNames, Url).ToList(),
-			Paths = Url.Paths.Union(Url.PathsWithDeprecations).ToArray(),
+			Paths = Url.FinalPaths,
 			Parts = Url.Parts,
 			Params = Url.Params.Values.Where(p => !p.Skip).ToList(),
 			HasBody = Body != null,
@@ -41,18 +41,18 @@ public class ApiEndpoint
 		public string HighLevelMethodXmlDocDescription =>
 			$"<c>{PreferredHttpMethod}</c> request to the <c>{Name}</c> API, read more about this API online:";
 
-		public HighLevelModel HighLevelModel => new HighLevelModel
+		public HighLevelModel HighLevelModel => new()
 		{
 			CsharpNames = CsharpNames,
 			Fluent = new FluentMethod(CsharpNames, Url.Parts,
-				Body == null || !Body.Required || HttpMethods.Contains("GET"),
+				Body is not { Required: true } || HttpMethods.Contains("GET"),
 				OfficialDocumentationLink?.Url,
 				HighLevelMethodXmlDocDescription
 			),
 			FluentBound = !CsharpNames.DescriptorBindsOverMultipleDocuments
 				? null
 				: new BoundFluentMethod(CsharpNames, Url.Parts,
-					Body == null || !Body.Required || HttpMethods.Contains("GET"),
+					Body is not { Required: true } || HttpMethods.Contains("GET"),
 					OfficialDocumentationLink?.Url,
 					HighLevelMethodXmlDocDescription
 				),
@@ -168,11 +168,7 @@ public string PreferredHttpMethod
 			CsharpNames = CsharpNames,
 			OfficialDocumentationLink = OfficialDocumentationLink?.Url,
 			Stability = Stability,
-			// Paths are used to generate API URL lookups
-			// Include deprecated paths to ensure these are not removed (a breaking change) during 7.x releases.
-			// For historical reasons, constructors for deprecated paths which specified a type where removed in 7.0 and
-			// therefore we don't include those in generation to avoid them being re-added.
-			Paths = Url.Paths.Union(Url.PathsWithDeprecations).Where(x => x.Parts.All(p => p.Name != "type")).ToArray(),
+			Paths = Url.FinalPaths,
 			Parts = Url.Parts,
 			Params = Url.Params.Values.Where(p => !p.Skip).ToList(),
 			Constructors = Constructor.RequestConstructors(CsharpNames, Url, true).ToList(),

src/ApiGenerator/Domain/Specification/UrlInformation.cs

@@ -5,6 +5,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using ApiGenerator.Configuration;
 using Newtonsoft.Json;
 
 namespace ApiGenerator.Domain.Specification
@@ -18,6 +19,14 @@ public class UrlInformation
 
 		private List<UrlPath> _pathsWithDeprecation;
 
+		// Include deprecated paths to ensure these are not removed (a breaking change) during 7.x releases.
+		// For historical reasons, constructors for deprecated paths which specified a type where removed in 7.0 and
+		// therefore we don't include those in generation to avoid them being re-added.
+		public IReadOnlyCollection<UrlPath> FinalPaths =>
+			Paths.Union(PathsWithDeprecations.Where(x => x.Parts.All(p => p.Name != "type")))
+				.Where(x => !GeneralSkipList.SkippedUrls.Contains(x.Path))
+				.ToArray();
+
 		public bool IsDocumentApi => IsADocumentRoute(Parts);
 
 		public bool IsPartless => !Parts.Any();
@@ -27,10 +36,7 @@ public class UrlInformation
 
 		public IDictionary<string, QueryParameters> Params { get; set; } = new SortedDictionary<string, QueryParameters>();
 
-		// Include deprecated paths to ensure these are not removed (a breaking change) during 7.x releases.
-		// For historical reasons, constructors for deprecated paths which specified a type where removed in 7.0 and
-		// therefore we don't include those in generation to avoid them being re-added.
-		public IReadOnlyCollection<UrlPart> Parts => Paths.Union(PathsWithDeprecations.Where(x => x.Parts.All(p => p.Name != "type")))
+		public IReadOnlyCollection<UrlPart> Parts => FinalPaths
 			.SelectMany(p => p.Parts)
 			.DistinctBy(p => p.Name)
 			.ToList();