Merge branch 'master' into validateDocumentStructure

OneDrive · Mar 11, 2024 · 3c376f2 · 3c376f2
2 parents 1ad5e4d + f00334d
commit 3c376f2
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 7 deletions.
diff --git a/ApiDoctor.Validation/DocFile.cs b/ApiDoctor.Validation/DocFile.cs
@@ -1301,10 +1301,22 @@ private void PostProcessResources(List<ResourceDefinition> foundResources, List<
                                 return;
                             }
 
+                            var listOfTextToRemoveFromPropertyNames = DocSet.SchemaConfig?.TextToRemoveFromPropertyNames ?? [];
+                            var parametersFromTableDefinition = table.Rows.Cast<ParameterDefinition>()
+                            .Select(param =>
+                            {
+                                foreach (string text in listOfTextToRemoveFromPropertyNames)
+                                {
+                                    param.Name = param.Name.Replace(text, "").Trim();
+                                }
+                                return param;
+                            });
+
+
                             table.UsedIn.Add(onlyResource);
                             MergeParametersIntoCollection(
                                 onlyResource.Parameters,
-                                table.Rows.Cast<ParameterDefinition>(),
+                                parametersFromTableDefinition,
                                 issues.For(onlyResource.Name),
                                 addMissingParameters: true,
                                 expectedInResource: true,

diff --git a/ApiDoctor.Validation/DocSet.cs b/ApiDoctor.Validation/DocSet.cs
@@ -415,6 +415,7 @@ public bool ScanDocumentation(string tags, IssueLogger issues)
                         $"Missing value for referenced base type in resource {resource.Name}");
                 }
 
+                var docIssues = issues.For(resource.SourceFile.DisplayName);
                 foreach (var param in resource.Parameters)
                 {
                     if (param.Type?.CustomTypeName != null)
@@ -427,7 +428,7 @@ public bool ScanDocumentation(string tags, IssueLogger issues)
                     {
                         if (string.IsNullOrWhiteSpace(resource.BaseType) || !resource.ResolvedBaseTypeReference.HasOrInheritsProperty(param.Name))
                         {
-                            issues.Error(ValidationErrorCode.AdditionalPropertyDetected,
+                            docIssues.Error(ValidationErrorCode.AdditionalPropertyDetected,
                                 $"Property '{param.Name}' found in resource definition for '{resource.Name}', but not described in markdown table.");
                         }
                     }

diff --git a/ApiDoctor.Validation/OData/Transformation/SchemaConfigFile.cs b/ApiDoctor.Validation/OData/Transformation/SchemaConfigFile.cs
@@ -43,11 +43,12 @@ public class SchemaConfig
     {
         public SchemaConfig()
         {
-            RequiredYamlHeaders = new string[] {};
-            FoldersToSkip = new List<string>();
-            FilesToSkip = new List<string>();
-            TreatErrorsAsWarningsWorkloads = new List<string>();
-            SkipPermissionTableUpdateForWorkloads = new List<string>();
+            RequiredYamlHeaders = [];
+            FoldersToSkip = [];
+            FilesToSkip = [];
+            TreatErrorsAsWarningsWorkloads = [];
+            SkipPermissionTableUpdateForWorkloads = [];
+
         }
 
         /// <summary>
@@ -103,6 +104,12 @@ public SchemaConfig()
         /// </summary>
         [JsonProperty("skipPermissionTableUpdateForWorkloads")]
         public List<string> SkipPermissionTableUpdateForWorkloads { get; set; }
+
+        /// <summary>
+        /// Text to remove from property names
+        /// </summary>
+        [JsonProperty("textToRemoveFromPropertyNames")]
+        public List<string> TextToRemoveFromPropertyNames { get; set; }
     }
 
     public class SchemaDiffConfig