Merge pull request #880 from mandy-chessell/dev-dojo

Minor fixes to type descriptions
odpi · Jan 2, 2024 · 706b573 · 706b573
2 parents 9f5abb6 + 145be78
commit 706b573
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 66 deletions.
diff --git a/site/docs/types/0/0011-Managing-Referenceables.md b/site/docs/types/0/0011-Managing-Referenceables.md
@@ -43,7 +43,12 @@ The *sourceVersionNumber* identifies the version number of the template used whe
 
 ## CatalogTemplate relationship
 
-The *CatalogTemplate* relationship links an *OpenMetadataRoot* entity that describes a class of technology with a [template](/features/templated-cataloguing/overview) for creating a catalog entry for a resource of this class.
+The *CatalogTemplate* relationship links an *OpenMetadataRoot* entity that describes a class of technology with a [template](/features/templated-cataloguing/overview) for creating a catalog entry for a resource of this class.  The attributes are used to help a user select the template, and then provide new property values to override the values in the template.
+
+* *templateName* - provides a name for the template.
+* *templateDescription* - describes what the template contains.
+* *replacementProperties* - lists properties whose values from the template should be overridden when creating a new element from the template. The map is from attribute name to the value to replace it with.  This can be used for numeric and boolean values as well as string values.
+* *placeholderProperties* - lists properties that contains strings to override placeholder strings, formatted with two sets of curly-braces, such as `{{placeholder}}`.  The map is from placeholder name to value to replace it with.
 
 ??? deprecated "Deprecated types"
     - *LastAttachment* - use *LatestChange* instead

diff --git a/site/docs/types/0/0011-Managing-Referenceables.svg b/site/docs/types/0/0011-Managing-Referenceables.svg
diff --git a/site/docs/types/0/area-0-basic-types-and-infrastructure.drawio b/site/docs/types/0/area-0-basic-types-and-infrastructure.drawio
@@ -1,6 +1,6 @@
-<mxfile modified="2023-12-22T06:12:58.772Z" host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="-YqYyVRNZfL7-N32PYiD" version="21.6.8" type="device" pages="32">
+<mxfile modified="2024-01-02T09:37:02.571Z" host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="SjxOGDc__AB5Hk3ywKiH" version="21.6.8" type="device" pages="32">
   <diagram id="jIWasjkcupAm6ooTX9ot" name="overview">
-    <mxGraphModel dx="1114" dy="775" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
+    <mxGraphModel dx="1194" dy="775" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
       <root>
         <mxCell id="0" />
         <mxCell id="1" parent="0" />
@@ -443,7 +443,7 @@
     </mxGraphModel>
   </diagram>
   <diagram name="0011-Managing-Referenceables" id="vxQgPqhZbHNzsHuqMvmY">
-    <mxGraphModel dx="1114" dy="775" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
+    <mxGraphModel dx="1194" dy="775" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
       <root>
         <mxCell id="Hnb-yI7sagTfC-MPkJIY-0" />
         <mxCell id="Hnb-yI7sagTfC-MPkJIY-1" parent="Hnb-yI7sagTfC-MPkJIY-0" />
@@ -532,40 +532,40 @@
         <mxCell id="hcazOuH14ZbhjFIotIwG-2" value="&lt;br&gt;&lt;div style=&quot;text-align: left&quot;&gt;&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;gradientColor=#ffffff;align=left;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
           <mxGeometry x="40" y="307" width="240" height="30" as="geometry" />
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-0" value="«entity»&lt;br&gt;&lt;b&gt;OpenMetadataRoot&lt;/b&gt;" style="html=1;strokeColor=#d6b656;align=center;fillColor=#fff2cc;gradientColor=#ffd966;" vertex="1" parent="Hnb-yI7sagTfC-MPkJIY-1">
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-0" value="«entity»&lt;br&gt;&lt;b&gt;OpenMetadataRoot&lt;/b&gt;" style="html=1;strokeColor=#d6b656;align=center;fillColor=#fff2cc;gradientColor=#ffd966;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
           <mxGeometry x="590" y="734" width="160" height="50" as="geometry" />
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-1" value="" style="endArrow=none;html=1;startArrow=oval;startFill=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="Hnb-yI7sagTfC-MPkJIY-1" source="YzhVfu5dpijQ73bxV_L5-0">
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-1" value="" style="endArrow=none;html=1;startArrow=oval;startFill=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" parent="Hnb-yI7sagTfC-MPkJIY-1" source="YzhVfu5dpijQ73bxV_L5-0" edge="1">
           <mxGeometry width="50" height="50" relative="1" as="geometry">
             <mxPoint x="-126.5" y="1001" as="sourcePoint" />
             <mxPoint x="250" y="759" as="targetPoint" />
           </mxGeometry>
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-2" value="*" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="Hnb-yI7sagTfC-MPkJIY-1">
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-2" value="*" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
           <mxGeometry x="250" y="764" width="40" height="20" as="geometry" />
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-3" value="implementationTypes" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="Hnb-yI7sagTfC-MPkJIY-1">
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-3" value="implementationTypes" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
           <mxGeometry x="250" y="784" width="129.5" height="20" as="geometry" />
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-4" value="templatesForCataloguing" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="Hnb-yI7sagTfC-MPkJIY-1">
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-4" value="templatesForCataloguing" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
           <mxGeometry x="440" y="784" width="150" height="20" as="geometry" />
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-5" value="*" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="Hnb-yI7sagTfC-MPkJIY-1">
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-5" value="*" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
           <mxGeometry x="550" y="764" width="40" height="20" as="geometry" />
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-6" value="" style="endArrow=none;dashed=1;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="Hnb-yI7sagTfC-MPkJIY-1" target="YzhVfu5dpijQ73bxV_L5-7">
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-6" value="" style="endArrow=none;dashed=1;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" parent="Hnb-yI7sagTfC-MPkJIY-1" target="YzhVfu5dpijQ73bxV_L5-7" edge="1">
           <mxGeometry width="50" height="50" relative="1" as="geometry">
             <mxPoint x="420" y="760" as="sourcePoint" />
             <mxPoint x="563" y="675" as="targetPoint" />
           </mxGeometry>
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-7" value="templateName : string&lt;br&gt;templateDescription : string&lt;br&gt;replacementProperties : map&amp;lt;string, string&amp;gt;" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;gradientColor=#ffffff;align=left;" vertex="1" parent="Hnb-yI7sagTfC-MPkJIY-1">
-          <mxGeometry x="292" y="647" width="256" height="70" as="geometry" />
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-7" value="templateName : string&lt;br&gt;templateDescription : string&lt;br&gt;replacementProperties : map&amp;lt;string, string&amp;gt;&lt;br&gt;placeholderProperties : map&amp;lt;string, string&amp;gt;" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;gradientColor=#ffffff;align=left;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
+          <mxGeometry x="292" y="630" width="256" height="87" as="geometry" />
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-8" value="«relationship»&lt;br&gt;&lt;b&gt;CatalogTemplate&lt;/b&gt;" style="html=1;strokeColor=#d6b656;align=center;fillColor=#fff2cc;gradientColor=#ffd966;" vertex="1" parent="Hnb-yI7sagTfC-MPkJIY-1">
-          <mxGeometry x="292" y="597" width="256" height="50" as="geometry" />
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-8" value="«relationship»&lt;br&gt;&lt;b&gt;CatalogTemplate&lt;/b&gt;" style="html=1;strokeColor=#d6b656;align=center;fillColor=#fff2cc;gradientColor=#ffd966;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
+          <mxGeometry x="292" y="583.5" width="256" height="50" as="geometry" />
         </mxCell>
-        <mxCell id="YzhVfu5dpijQ73bxV_L5-9" value="«entity»&lt;br&gt;&lt;b&gt;OpenMetadataRoot&lt;/b&gt;" style="html=1;strokeColor=#d6b656;align=center;fillColor=#fff2cc;gradientColor=#ffd966;" vertex="1" parent="Hnb-yI7sagTfC-MPkJIY-1">
+        <mxCell id="YzhVfu5dpijQ73bxV_L5-9" value="«entity»&lt;br&gt;&lt;b&gt;OpenMetadataRoot&lt;/b&gt;" style="html=1;strokeColor=#d6b656;align=center;fillColor=#fff2cc;gradientColor=#ffd966;" parent="Hnb-yI7sagTfC-MPkJIY-1" vertex="1">
           <mxGeometry x="90" y="734" width="160" height="50" as="geometry" />
         </mxCell>
       </root>

diff --git a/site/docs/types/2/0210-Data-Stores.md b/site/docs/types/2/0210-Data-Stores.md
@@ -31,6 +31,7 @@ The *DataScope* classification identifies the scope of the data stored in the [r
 * *maxHeight* - if the height above ground is relevant, this is the highest height that the data covers.
 * *startTime* - if the data is bound by time, this is the start time.
 * *endTime* - if the data is bound by time, this is the end time.
+* *additionalProperties* - to support other properties that identify the scope of the data represented by this element.
 
 
 --8<-- "snippets/abbr.md"
diff --git a/site/docs/types/2/0210-Data-Stores.svg b/site/docs/types/2/0210-Data-Stores.svg
diff --git a/site/docs/types/2/0227-Keystores.svg b/site/docs/types/2/0227-Keystores.svg
diff --git a/site/docs/types/2/0280-Software-Development-Assets.svg b/site/docs/types/2/0280-Software-Development-Assets.svg