From 99824b4972e0d6a2a6a5167ad5a21eb4692fa5ec Mon Sep 17 00:00:00 2001 From: Ellie O'Neil <110510035+eboneil@users.noreply.github.com> Date: Mon, 26 Aug 2024 11:18:53 -0700 Subject: [PATCH] docs(urn): Update urn docs with restrictions (#11213) Co-authored-by: John Joyce --- docs/what/urn.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/what/urn.md b/docs/what/urn.md index fbead110afe0a..122b93038d9de 100644 --- a/docs/what/urn.md +++ b/docs/what/urn.md @@ -32,3 +32,13 @@ urn:li:corpuser:jdoe urn:li:dataset:(urn:li:dataPlatform:kafka,PageViewEvent,PROD) urn:li:dataset:(urn:li:dataPlatform:hdfs,PageViewEvent,EI) ``` + +## Restrictions + +There are a few restrictions when creating an urn: + +1. Commas are reserved character in URN fields: `,` +2. Parentheses are reserved characters in URN fields: `( , )` +3. Colons are reserved characters in URN fields: `:` + +Please do not use these characters when creating or generating urns.