docs(urn): Update urn docs with restrictions (#11213)

Co-authored-by: John Joyce <[email protected]>
datahub-project · Aug 26, 2024 · 99824b4 · 99824b4
1 parent ca4c436
commit 99824b4
Showing 1 changed file with 10 additions and 0 deletions.
diff --git 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.