From e332cfacdb9d41382a409fb9bc8e94fc63a67d17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Wed, 22 Jan 2025 11:42:34 +0100 Subject: [PATCH] strengthen the case sensitivity statements about refs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .github/vale/config/vocabularies/Backstage/accept.txt | 1 + docs/features/software-catalog/references.md | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/vale/config/vocabularies/Backstage/accept.txt b/.github/vale/config/vocabularies/Backstage/accept.txt index 34ea8cc894..9de05aab88 100644 --- a/.github/vale/config/vocabularies/Backstage/accept.txt +++ b/.github/vale/config/vocabularies/Backstage/accept.txt @@ -228,6 +228,7 @@ LocalStack lockdown lockfile lookbehind +lowercased lunr Luxon magiclink diff --git a/docs/features/software-catalog/references.md b/docs/features/software-catalog/references.md index 2240d376ce..9a5a037d6d 100644 --- a/docs/features/software-catalog/references.md +++ b/docs/features/software-catalog/references.md @@ -36,7 +36,13 @@ additional encoding: The name is always required. Depending on the context, you may be able to leave out the kind and/or namespace. If you do, it is contextual what values will be used, and the relevant documentation should specify which rule applies where. -All strings are case insensitive. + +Entity ref strings are frequently passed between systems as identifiers of +entities. In those cases the refs should always be complete (have all three +parts). The sender should ensure that the refs are always lowercased in an +`en-US` locale, preferably by using [the `stringifyEntityRef` function](https://backstage.io/docs/reference/catalog-model.stringifyentityref/) +which does this automatically. The receiver should treat incoming refs case +insensitively to avoid problems with senders who do not obey this rule. ```yaml # Example: