Change warning to error for when a property is defined in JSON repres…

…entation of table but not in markdown table (#248)
OneDrive · Feb 5, 2024 · 2307495 · 2307495
1 parent 5501a5c
commit 2307495
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/ApiDoctor.Validation/DocFile.cs b/ApiDoctor.Validation/DocFile.cs
@@ -1154,11 +1154,6 @@ private void PostProcessResources(List<ResourceDefinition> foundResources, List<
                         {
                             paramsToRemove.Add(param);
                         }
-                        else
-                        {
-                            issues.Warning(ValidationErrorCode.AdditionalPropertyDetected,
-                                $"Property '{param.Name}' found in resource definition for '{onlyResource.Name}', but not described in markdown table.");
-                        }
                     }
                 }
 

diff --git a/ApiDoctor.Validation/DocSet.cs b/ApiDoctor.Validation/DocSet.cs
@@ -417,6 +417,16 @@ public bool ScanDocumentation(string tags, IssueLogger issues)
                     {
                         EnsureDefinedInDocs(param.Type.CustomTypeName, definedTypes, resource.SourceFile, resourceIssues.For(param.Name));
                     }
+
+                    // if parameter does not have a description, then it's from the resource JSON definition
+                    if (string.IsNullOrEmpty(param.Description) && !param.Name.Contains('@'))
+                    {
+                        if (string.IsNullOrWhiteSpace(resource.BaseType) || !resource.ResolvedBaseTypeReference.HasOrInheritsProperty(param.Name))
+                        {
+                            issues.Error(ValidationErrorCode.AdditionalPropertyDetected,
+                                $"Property '{param.Name}' found in resource definition for '{resource.Name}', but not described in markdown table.");
+                        }
+                    }
                 }
 
                 if (!string.IsNullOrEmpty(resource.KeyPropertyName) &&
-Original file line number
+Diff line change
@@ Expand Up @@
                             {
                                 paramsToRemove.Add(param);
                             }
-                            else
-                            {
-                                issues.Warning(ValidationErrorCode.AdditionalPropertyDetected,
-                                    $"Property '{param.Name}' found in resource definition for '{onlyResource.Name}', but not described in markdown table.");
-                            }
                         }
                     }
@@ Expand Down @@