Skip to content

fix: correct JSON field name typo "ValidationIssuses" → "ValidationIssues" #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Yanhu007 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: correct JSON field name typo "ValidationIssuses" → "ValidationIssues" #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf1fb41
fix: correct JSON field name typo "ValidationIssuses" -> "ValidationI…
Yanhu007 Apr 14, 2026
f7a706a
docs: add migration note for renamed ValidationIssues JSON field
Yanhu007 Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...-creator/report/testdata/CreationOfMissingCRsAndUnmatchedCRsAndDiffTestsSuitesWhenNoDiffs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Summary":{"ValidationIssuses":{},"NumMissing":0,"UnmatchedCRS":[],"NumDiffCRs":0,"TotalCRs":27,"MetadataHash":"933892b7ae8a4f5232734acc34f6c93fc223844d836b37af390cfeaecf0b7a99","patchedCRs":0},"Diffs":[{"DiffOutput":"","CorrelatedTemplate":"cm.yaml","CRName":"v1_ConfigMap_kubernetes-dashboard_kubernetes-dashboard-settings"},{"DiffOutput":"","CorrelatedTemplate":"cr.yaml","CRName":"rbac.authorization.k8s.io/v1_ClusterRole_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"crb.yaml","CRName":"rbac.authorization.k8s.io/v1_ClusterRoleBinding_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"deploymentDashboard.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"deploymentMetrics.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_dashboard-metrics-scraper"},{"DiffOutput":"","CorrelatedTemplate":"ns.yaml","CRName":"v1_Namespace_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"rb.yaml","CRName":"rbac.authorization.k8s.io/v1_RoleBinding_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"role.yaml","CRName":"rbac.authorization.k8s.io/v1_Role_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"sa.yaml","CRName":"v1_ServiceAccount_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-certs"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-csrf"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-key-holder"},{"DiffOutput":"","CorrelatedTemplate":"service.yaml","CRName":"v1_Service_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"ns.yaml","CRName":"v1_Namespace_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"sa.yaml","CRName":"v1_ServiceAccount_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"service.yaml","CRName":"v1_Service_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-certs"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-csrf"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-key-holder"},{"DiffOutput":"","CorrelatedTemplate":"cm.yaml","CRName":"v1_ConfigMap_kubernetes-dashboard_kubernetes-dashboard-settings"},{"DiffOutput":"","CorrelatedTemplate":"role.yaml","CRName":"rbac.authorization.k8s.io/v1_Role_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"cr.yaml","CRName":"rbac.authorization.k8s.io/v1_ClusterRole_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"rb.yaml","CRName":"rbac.authorization.k8s.io/v1_RoleBinding_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"crb.yaml","CRName":"rbac.authorization.k8s.io/v1_ClusterRoleBinding_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"deploymentDashboard.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"service.yaml","CRName":"v1_Service_kubernetes-dashboard_dashboard-metrics-scraper"},{"DiffOutput":"","CorrelatedTemplate":"deploymentMetrics.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_dashboard-metrics-scraper"}]}
{"Summary":{"ValidationIssues":{},"NumMissing":0,"UnmatchedCRS":[],"NumDiffCRs":0,"TotalCRs":27,"MetadataHash":"933892b7ae8a4f5232734acc34f6c93fc223844d836b37af390cfeaecf0b7a99","patchedCRs":0},"Diffs":[{"DiffOutput":"","CorrelatedTemplate":"cm.yaml","CRName":"v1_ConfigMap_kubernetes-dashboard_kubernetes-dashboard-settings"},{"DiffOutput":"","CorrelatedTemplate":"cr.yaml","CRName":"rbac.authorization.k8s.io/v1_ClusterRole_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"crb.yaml","CRName":"rbac.authorization.k8s.io/v1_ClusterRoleBinding_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"deploymentDashboard.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"deploymentMetrics.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_dashboard-metrics-scraper"},{"DiffOutput":"","CorrelatedTemplate":"ns.yaml","CRName":"v1_Namespace_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"rb.yaml","CRName":"rbac.authorization.k8s.io/v1_RoleBinding_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"role.yaml","CRName":"rbac.authorization.k8s.io/v1_Role_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"sa.yaml","CRName":"v1_ServiceAccount_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-certs"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-csrf"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-key-holder"},{"DiffOutput":"","CorrelatedTemplate":"service.yaml","CRName":"v1_Service_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"ns.yaml","CRName":"v1_Namespace_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"sa.yaml","CRName":"v1_ServiceAccount_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"service.yaml","CRName":"v1_Service_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-certs"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-csrf"},{"DiffOutput":"","CorrelatedTemplate":"secret.yaml","CRName":"v1_Secret_kubernetes-dashboard_kubernetes-dashboard-key-holder"},{"DiffOutput":"","CorrelatedTemplate":"cm.yaml","CRName":"v1_ConfigMap_kubernetes-dashboard_kubernetes-dashboard-settings"},{"DiffOutput":"","CorrelatedTemplate":"role.yaml","CRName":"rbac.authorization.k8s.io/v1_Role_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"cr.yaml","CRName":"rbac.authorization.k8s.io/v1_ClusterRole_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"rb.yaml","CRName":"rbac.authorization.k8s.io/v1_RoleBinding_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"crb.yaml","CRName":"rbac.authorization.k8s.io/v1_ClusterRoleBinding_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"deploymentDashboard.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_kubernetes-dashboard"},{"DiffOutput":"","CorrelatedTemplate":"service.yaml","CRName":"v1_Service_kubernetes-dashboard_dashboard-metrics-scraper"},{"DiffOutput":"","CorrelatedTemplate":"deploymentMetrics.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_dashboard-metrics-scraper"}]}
2 changes: 1 addition & 1 deletion addon-tools/report-creator/report/testdata/DiffTestSuiteCreationWhenThereAreDiffs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Summary":{"ValidationIssuses":{},"NumMissing":0,"UnmatchedCRS":[],"NumDiffCRs":1,"TotalCRs":1,"MetadataHash":"013675dbf39d109d2e17bef23e4786717e5439e5490cf20853af5481f0818c40","patchedCRs":0},"Diffs":[{"DiffOutput":"diff -u -N TEMP/v1_configmap_kubernetes-dashboard_kubernetes-dashboard-settings TEMP/v1_configmap_kubernetes-dashboard_kubernetes-dashboard-settings\n--- TEMP/v1_configmap_kubernetes-dashboard_kubernetes-dashboard-settings\tDATE\n+++ TEMP/v1_configmap_kubernetes-dashboard_kubernetes-dashboard-settings\tDATE\n@@ -2,6 +2,6 @@\n kind: ConfigMap\n metadata:\n labels:\n- k8s-app: kubernetes-dashboardfunction was called successfully from different file\n+ k8s-app: kubernetes-dashboard\n name: kubernetes-dashboard-settings\n namespace: kubernetes-dashboard\n","CorrelatedTemplate":"cm.yaml","CRName":"v1_ConfigMap_kubernetes-dashboard_kubernetes-dashboard-settings"}]}
{"Summary":{"ValidationIssues":{},"NumMissing":0,"UnmatchedCRS":[],"NumDiffCRs":1,"TotalCRs":1,"MetadataHash":"013675dbf39d109d2e17bef23e4786717e5439e5490cf20853af5481f0818c40","patchedCRs":0},"Diffs":[{"DiffOutput":"diff -u -N TEMP/v1_configmap_kubernetes-dashboard_kubernetes-dashboard-settings TEMP/v1_configmap_kubernetes-dashboard_kubernetes-dashboard-settings\n--- TEMP/v1_configmap_kubernetes-dashboard_kubernetes-dashboard-settings\tDATE\n+++ TEMP/v1_configmap_kubernetes-dashboard_kubernetes-dashboard-settings\tDATE\n@@ -2,6 +2,6 @@\n kind: ConfigMap\n metadata:\n labels:\n- k8s-app: kubernetes-dashboardfunction was called successfully from different file\n+ k8s-app: kubernetes-dashboard\n name: kubernetes-dashboard-settings\n namespace: kubernetes-dashboard\n","CorrelatedTemplate":"cm.yaml","CRName":"v1_ConfigMap_kubernetes-dashboard_kubernetes-dashboard-settings"}]}
2 changes: 1 addition & 1 deletion addon-tools/report-creator/report/testdata/MissingCRstestsuitecreationwhenCRSareMissing
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Summary":{"ValidationIssuses":{"ExamplePart1":{"Dashboard1":{"Msg":"Missing CRs","CRs":["cm.yaml"]},"Dashboard2":{"Msg":"Missing CRs","CRs":["deploymentDashboard.yaml","deploymentMetrics.yaml"]}},"ExamplePart2":{"Dashboard1":{"Msg":"Missing CRs","CRs":["cr.yaml"]},"Dashboard2":{"Msg":"Missing CRs","CRs":["crb.yaml"]}}},"NumMissing":5,"UnmatchedCRS":[],"NumDiffCRs":0,"TotalCRs":1,"MetadataHash":"98dca024e0509f46f0a228da2ad61b98804a3f4b5a7ad1ac31d41b46812c32ea","patchedCRs":0},"Diffs":[{"DiffOutput":"","CorrelatedTemplate":"ns.yaml","CRName":"v1_Namespace_kubernetes-dashboard"}]}
{"Summary":{"ValidationIssues":{"ExamplePart1":{"Dashboard1":{"Msg":"Missing CRs","CRs":["cm.yaml"]},"Dashboard2":{"Msg":"Missing CRs","CRs":["deploymentDashboard.yaml","deploymentMetrics.yaml"]}},"ExamplePart2":{"Dashboard1":{"Msg":"Missing CRs","CRs":["cr.yaml"]},"Dashboard2":{"Msg":"Missing CRs","CRs":["crb.yaml"]}}},"NumMissing":5,"UnmatchedCRS":[],"NumDiffCRs":0,"TotalCRs":1,"MetadataHash":"98dca024e0509f46f0a228da2ad61b98804a3f4b5a7ad1ac31d41b46812c32ea","patchedCRs":0},"Diffs":[{"DiffOutput":"","CorrelatedTemplate":"ns.yaml","CRName":"v1_Namespace_kubernetes-dashboard"}]}
4 changes: 3 additions & 1 deletion docs/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,12 @@ easily parsed by other software.

For example:

> **Note:** The JSON field `Summary.ValidationIssuses` was renamed to `Summary.ValidationIssues` (typo fix). Consumers parsing the old key name must update.

```json
{
"Summary": {
"ValidationIssuses": {
"ValidationIssues": {
"ExamplePart": {
"Dashboard": {
"Msg": "Missing CRs",
Expand Down
2 changes: 1 addition & 1 deletion pkg/compare/output.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ func (s DiffSum) WasPatched() bool {

// Summary Contains all info included in the Summary output of the compare command
type Summary struct {
ValidationIssues map[string]map[string]ValidationIssue `json:"ValidationIssuses"`
ValidationIssues map[string]map[string]ValidationIssue `json:"ValidationIssues"`
NumMissing int `json:"NumMissing"`
UnmatchedCRS []string `json:"UnmatchedCRS"`
NumDiffCRs int `json:"NumDiffCRs"`
Expand Down
2 changes: 1 addition & 1 deletion pkg/compare/testdata/JSONOutput/localout.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"Summary":{"ValidationIssuses":{"ExamplePart":{"Dashboard":{"Msg":"Missing CRs","CRs":["deploymentDashboard.yaml"]}}},"NumMissing":1,"UnmatchedCRS":[],"NumDiffCRs":1,"TotalCRs":1,"MetadataHash":"aa4c94f1307788e1da81f57718a9f1364d35d4ff6099fc633724bcf9d051a094","patchedCRs":0},"Diffs":[{"DiffOutput":"diff -u -N TEMP/apps-v1_deployment_kubernetes-dashboard_dashboard-metrics-scraper TEMP/apps-v1_deployment_kubernetes-dashboard_dashboard-metrics-scraper\n--- TEMP/apps-v1_deployment_kubernetes-dashboard_dashboard-metrics-scraper\tDATE\n+++ TEMP/apps-v1_deployment_kubernetes-dashboard_dashboard-metrics-scraper\tDATE\n@@ -10,7 +10,7 @@\n revisionHistoryLimit: 10\n selector:\n matchLabels:\n- k8s-app: dashboard-metrics-scraper\n+ k8s-app: dashboard-metrics-scraper-diff\n template:\n metadata:\n labels:\n","CorrelatedTemplate":"deploymentMetrics.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_dashboard-metrics-scraper"}]}
{"Summary":{"ValidationIssues":{"ExamplePart":{"Dashboard":{"Msg":"Missing CRs","CRs":["deploymentDashboard.yaml"]}}},"NumMissing":1,"UnmatchedCRS":[],"NumDiffCRs":1,"TotalCRs":1,"MetadataHash":"aa4c94f1307788e1da81f57718a9f1364d35d4ff6099fc633724bcf9d051a094","patchedCRs":0},"Diffs":[{"DiffOutput":"diff -u -N TEMP/apps-v1_deployment_kubernetes-dashboard_dashboard-metrics-scraper TEMP/apps-v1_deployment_kubernetes-dashboard_dashboard-metrics-scraper\n--- TEMP/apps-v1_deployment_kubernetes-dashboard_dashboard-metrics-scraper\tDATE\n+++ TEMP/apps-v1_deployment_kubernetes-dashboard_dashboard-metrics-scraper\tDATE\n@@ -10,7 +10,7 @@\n revisionHistoryLimit: 10\n selector:\n matchLabels:\n- k8s-app: dashboard-metrics-scraper\n+ k8s-app: dashboard-metrics-scraper-diff\n template:\n metadata:\n labels:\n","CorrelatedTemplate":"deploymentMetrics.yaml","CRName":"apps/v1_Deployment_kubernetes-dashboard_dashboard-metrics-scraper"}]}
2 changes: 1 addition & 1 deletion pkg/compare/testdata/YAMLOutput/localout.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Summary:
NumMissing: 1
TotalCRs: 1
UnmatchedCRS: []
ValidationIssuses:
ValidationIssues:
ExamplePart:
Dashboard:
CRs:
Expand Down