From 409725e9c2f7152d5ff0c3bb592f0cc4722e552c Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Mon, 31 Jan 2022 07:11:45 -0600 Subject: [PATCH] Updated readme Signed-off-by: Andre Wanlin --- contrib/scripts/orphan-clean-up/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/contrib/scripts/orphan-clean-up/README.md b/contrib/scripts/orphan-clean-up/README.md index 444a020e1c..a6a25a4e7d 100644 --- a/contrib/scripts/orphan-clean-up/README.md +++ b/contrib/scripts/orphan-clean-up/README.md @@ -2,7 +2,9 @@ ## Overview -The Orphan Clean Up script is a basic PowerShell script to delete orphaned entities in the catalog. +The Orphan Clean Up script is a basic PowerShell script to delete orphaned entities in the catalog. This script also assumes that you do not have authentication setup for your Backstage API endpoints. + +_Warning:_ There is a risk of entities being orphaned (and being deleted by this script) in case of the location having problems and returning a 404 status code. This might lead to accidental deletion of entities until the processing loop has recreated the entity. ## Requirements