Fix high-level code gen for deprecated URLs (#5841) (#5843)

* Include deprecated URLs for ctor generation

* Remove some outdated patches

* Exclude type ctors params not included in 7.0

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

Author: github-actions[bot]

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

@@ -14,10 +14,10 @@ public class Constructor
 	{
 		private static readonly string Indent = $"{Environment.NewLine}\t\t";
 		public string AdditionalCode { get; set; } = string.Empty;
-		public bool Parameterless { get; set; }
 		public string Body { get; set; }
 		public string Description { get; set; }
 		public string Generated { get; set; }
+		public bool Parameterless { get; set; }
 
 		public static IEnumerable<Constructor> DescriptorConstructors(CsharpNames names, UrlInformation url)
 		{
@@ -47,7 +47,10 @@ string generic
 		{
 			var ctors = new List<Constructor>();
 
-			var paths = url.Paths.ToList();
+			// 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")));
 
 			if (url.IsPartless) return ctors;
 
@@ -77,7 +80,7 @@ string generic
 					{
 						Parameterless = string.IsNullOrEmpty(constructorArgs),
 						Generated = generated,
-						Description = path.GetXmlDocs(Indent, skipResolvable: true),
+						Description = path.GetXmlDocs(Indent, true),
 						Body = string.Empty
 					});
 
@@ -89,15 +92,14 @@ string generic
 					{
 						Parameterless = string.IsNullOrEmpty(docPathConstArgs),
 						Generated = $"public {typeName}({docPathConstArgs}) : this({docPathBaseArgs})",
-
 						AdditionalCode = $"partial void DocumentFromPath({generic} document);",
-						Description = docPath.GetXmlDocs(Indent, skipResolvable: true, documentConstructor: true),
+						Description = docPath.GetXmlDocs(Indent, true, true),
 						Body = "=> DocumentFromPath(documentWithId);"
 					});
 				}
 			}
 			var constructors = ctors.GroupBy(c => c.Generated.Split(new[] { ':' }, 2)[0]).Select(g => g.Last()).ToList();
-			if (!constructors.Any(c=>c.Parameterless))
+			if (!constructors.Any(c => c.Parameterless))
 				constructors.Add(new Constructor
 				{
 					Parameterless = true,

src/ApiGenerator/Domain/Specification/UrlInformation.cs

@@ -9,22 +9,32 @@
 
 namespace ApiGenerator.Domain.Specification
 {
-
 	// ReSharper disable once ClassNeverInstantiated.Global
 	public class UrlInformation
 	{
-		public IDictionary<string, QueryParameters> Params { get; set; } = new SortedDictionary<string, QueryParameters>();
+		private static readonly string[] DocumentApiParts = { "index", "id" };
 
-		[JsonProperty("paths")]
-		private IReadOnlyCollection<string> OriginalPaths { get; set; }
+		private List<UrlPath> _paths;
+
+		private List<UrlPath> _pathsWithDeprecation;
+
+		public bool IsDocumentApi => IsADocumentRoute(Parts);
+
+		public bool IsPartless => !Parts.Any();
 
 		[JsonProperty("parts")]
 		public IDictionary<string, UrlPart> OriginalParts { get; set; }
 
-		[JsonProperty("deprecated_paths")]
-		private IReadOnlyCollection<DeprecatedPath> DeprecatedPaths { get; set; }
+		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")))
+			.SelectMany(p => p.Parts)
+			.DistinctBy(p => p.Name)
+			.ToList();
 
-		private List<UrlPath> _paths;
 		public IReadOnlyCollection<UrlPath> Paths
 		{
 			get
@@ -36,14 +46,13 @@ public IReadOnlyCollection<UrlPath> Paths
 			}
 		}
 
-		private List<UrlPath> _pathsWithDeprecation;
 		public IReadOnlyCollection<UrlPath> PathsWithDeprecations
 		{
 			get
 			{
 				if (_pathsWithDeprecation != null && _pathsWithDeprecation.Count > 0) return _pathsWithDeprecation;
 
-				var paths = Paths ?? new UrlPath[] {};
+				var paths = Paths ?? new UrlPath[] { };
 				if (DeprecatedPaths == null || DeprecatedPaths.Count == 0) return Paths;
 				if (OriginalParts == null) return Paths;
 
@@ -58,8 +67,7 @@ public IReadOnlyCollection<UrlPath> PathsWithDeprecations
 				var withoutDeprecatedAliases = DeprecatedPaths
 					.Select(deprecatedPath => new
 					{
-						deprecatedPath,
-						parts = new HashSet<string>(OriginalParts.Keys.Where(k => deprecatedPath.Path.Contains($"{{{k}}}")))
+						deprecatedPath, parts = new HashSet<string>(OriginalParts.Keys.Where(k => deprecatedPath.Path.Contains($"{{{k}}}")))
 					})
 					.GroupBy(t => t.parts, HashSet<string>.CreateSetComparer())
 					.Where(grouped => !canonicalPartNameLookup.Any(set => set.SetEquals(grouped.Key)))
@@ -74,32 +82,23 @@ public IReadOnlyCollection<UrlPath> PathsWithDeprecations
 				var finalPathsWithDeprecations = new List<UrlPath>(_pathsWithDeprecation.Count);
 
 				foreach (var path in _pathsWithDeprecation)
-				{
 					if (path.Deprecation is null &&
 						DeprecatedPaths.SingleOrDefault(p => p.Path.Equals(path.Path, StringComparison.OrdinalIgnoreCase)) is { } match)
-					{
 						finalPathsWithDeprecations.Add(new UrlPath(match, OriginalParts, Paths));
-					}
 					else
-					{
 						finalPathsWithDeprecations.Add(path);
-					}
-				}
 
 				_pathsWithDeprecation = finalPathsWithDeprecations;
 
 				return _pathsWithDeprecation;
 			}
 		}
 
+		[JsonProperty("deprecated_paths")]
+		private IReadOnlyCollection<DeprecatedPath> DeprecatedPaths { get; set; }
 
-		public IReadOnlyCollection<UrlPart> Parts => Paths.SelectMany(p => p.Parts).DistinctBy(p => p.Name).ToList();
-
-		public bool IsPartless => !Parts.Any();
-
-		private static readonly string[] DocumentApiParts = { "index", "id" };
-
-		public bool IsDocumentApi => IsADocumentRoute(Parts);
+		[JsonProperty("paths")]
+		private IReadOnlyCollection<string> OriginalPaths { get; set; }
 
 		public static bool IsADocumentRoute(IReadOnlyCollection<UrlPart> parts) =>
 			parts.Count() == DocumentApiParts.Length
@@ -115,6 +114,5 @@ public bool TryGetDocumentApiPath(out UrlPath path)
 			path = new UrlPath(mostVerbosePath.Path, OriginalParts, mostVerbosePath.Parts);
 			return true;
 		}
-
 	}
 }

src/ApiGenerator/Domain/Specification/UrlPart.cs

@@ -89,6 +89,7 @@ public string HighLevelTypeName
 					case "id":
 						return "Id";
 
+					case "scroll_id":
 					case "policy_id":
 						return Type == "string" ? "Id" : "Ids";