From 38dd7d40648abddca5fa786a58f594600aff43eb Mon Sep 17 00:00:00 2001
From: George Shaw
Date: Fri, 7 Feb 2025 10:28:40 -0800
Subject: [PATCH] docs: add cleanPolicy enum values
* adds `cleanPolicy` enum values to the api reference documentation as
described in the public website https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-restore-cr
---
docs/api-references/docs.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/api-references/docs.md b/docs/api-references/docs.md
index 4167d783883..4b3061963c9 100644
--- a/docs/api-references/docs.md
+++ b/docs/api-references/docs.md
@@ -5343,7 +5343,7 @@ float64
BackupSpec)
-
CleanPolicyType represents the clean policy of backup data in remote storage
+CleanPolicyType represents the clean policy of backup data in remote storage. Retain (default) will under any circumstances, retain the backup data when deleting the backup CR. Delete will under any circumstances, delete the backup data when deleting the backup CR. OnFailure will delete the backup data when deleting the backup CR if the backup fails.
Cluster