Merge pull request #919 from mandy-chessell/code2024

Updates to open lineage
odpi · Apr 22, 2024 · 13d6d7f · 13d6d7f
2 parents bdb8a86 + 377c586
commit 13d6d7f
Show file tree

Hide file tree

Showing 24 changed files with 5,783 additions and 87 deletions.
diff --git a/site/docs/concepts/index.md b/site/docs/concepts/index.md
@@ -133,6 +133,7 @@
 - [Frameworks](/frameworks)
 
     - [Audit Log Framework (ALF)](/frameworks/alf/overview)
+    - [Open Metadata Framework (OMF)](/frameworks/omf/overview)
     - [Open Connector Framework (OCF)](/frameworks/ocf/overview)
     - [Open Integration Framework (OIF)](/frameworks/oif/overview)
     - [Governance Action Framework (GAF)](/frameworks/gaf/overview)

diff --git a/site/docs/features/lineage-management/lineage.drawio b/site/docs/features/lineage-management/lineage.drawio
diff --git a/site/docs/features/lineage-management/open-lineage-async-egeria-integration.svg b/site/docs/features/lineage-management/open-lineage-async-egeria-integration.svg
diff --git a/site/docs/features/lineage-management/open-lineage-direct-egeria-integration.svg b/site/docs/features/lineage-management/open-lineage-direct-egeria-integration.svg
diff --git a/site/docs/features/lineage-management/open-lineage.drawio b/site/docs/features/lineage-management/open-lineage.drawio
diff --git a/site/docs/features/lineage-management/overview.md b/site/docs/features/lineage-management/overview.md
diff --git a/site/docs/frameworks/gaf/overview.md b/site/docs/frameworks/gaf/overview.md
@@ -1,7 +1,7 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/tech-preview.md"
+--8<-- "snippets/content-status/stable.md"
 
 # Governance Action Framework (GAF)
 

diff --git a/site/docs/frameworks/index.md b/site/docs/frameworks/index.md
@@ -10,6 +10,8 @@ The open metadata and governance frameworks supported by Egeria are as follows:
 
 * *[Audit Log Framework (ALF)](/frameworks/alf/overview)* provides interfaces and classes to enable connectors of all types to support natural language diagnostic messages for both exceptions and the audit log.
 
+* *[Open Metadata Framework (OMF)](/frameworks/omf/overview)* defines constant values used to define the names within the open metadata type system and its supporting services. 
+* 
 * *[Open Connector Framework (OCF)](/frameworks/ocf/overview)* provides the interfaces and base implementations for components (called [connectors](/concepts/connector)) that access data-related assets. OCF connectors also provide [detailed metadata about the assets](/concepts/connected-asset-properties) they access.
 
 * *[Open Integration Framework (OIF)](/frameworks/oif/overview)* provides the interfaces and base implementations for connectors (called [integration connectors](/concepts/integration-connector)) that synchronize metadata between Egeria's open metadata ecosystem and third party technologies.  The integration connectors run in an [integration daemon](/concepts/integration-daemon).

diff --git a/site/docs/frameworks/odf/overview.md b/site/docs/frameworks/odf/overview.md
@@ -1,7 +1,7 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/tech-preview.md"
+--8<-- "snippets/content-status/deprecated.md"
 
 # Open Discovery Framework (ODF)
 

diff --git a/site/docs/frameworks/oif/overview.md b/site/docs/frameworks/oif/overview.md
@@ -1,6 +1,8 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the ODPi Egeria project 2020. -->
 
+--8<-- "snippets/content-status/stable.md"
+
 # Open Integration Framework (OIF)
 
 The *Open Integration Framework (OIF)* provides the interfaces for running [integration connectors](/concepts/integration-connector).

diff --git a/site/docs/frameworks/omf/overview.md b/site/docs/frameworks/omf/overview.md
@@ -0,0 +1,11 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+--8<-- "snippets/content-status/stable.md"
+
+# Open Metadata Framework (OMF)
+
+The *Open Metadata Framework (OMF)* contains the definition of constant values used to define the names within the open metadata type system and its supporting services.
+
+
+--8<-- "snippets/abbr.md"
diff --git a/site/docs/services/omvs/automated-curation/overview.md b/site/docs/services/omvs/automated-curation/overview.md
@@ -6,7 +6,7 @@ hide:
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/in-development.md"
+--8<-- "snippets/content-status/tech-preview.md"
 
 # Automated Curation Open Metadata View Service (OMVS)
 

diff --git a/site/docs/services/omvs/collection-manager/overview.md b/site/docs/services/omvs/collection-manager/overview.md
@@ -1,7 +1,7 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/in-development.md"
+--8<-- "snippets/content-status/tech-preview.md"
 
 # Collection Manager OMVS
 
@@ -25,9 +25,16 @@ The Collection Manager OMVS supports:
 
 ## Managing collection entities
 
+When working with collections, there are 4 concepts that you need to keep in mind:
+
+* Which elements, if any, is the collection linking to.  These elements are called the parent elements.
+* Is the collection its own [anchor](/featires/anchor-management/overview) or is it anchored to another element.
+* What values should be assigned to it attributes.
+* Which classifications should be added to the collection to indicate its purpose and usage.
 
 ### createCollection (no parent relationship)
-Create a new generic collection.
+
+This first example of a create request is for a collection that is its own anchor and is to be created without a parent.  The placeholder property `{{classificationName}}` is set to a [valid classification name](/types/0/0021-Collections/#collection-classifications) for the collection.
 ```
 POST {{baseURL}}/servers/{{viewServer}}/api/open-metadata/collection-manager/collections?classificationName={{classificationName}}
 Authorization: Bearer {{token}}
@@ -40,14 +47,13 @@ Content-Type: application/json
     "qualifiedName": "Must provide a unique name here",
     "name" : "Add display name here",
     "description" : "Add description of the collection here",
-    "collectionType": "Add appropriate valid value for type",
-    "collectionOrdering" : "OTHER",
-    "orderPropertyName" : "Add property name if 'collectionOrdering' is OTHER"
+    "collectionType": "Add appropriate valid value for type"
   }
 }
 ```
 ### createCollection (with parent)
-Create a new generic collection.
+
+
 
 ```
 POST {{baseURL}}/servers/{{viewServer}}/api/open-metadata/collection-manager/collections

diff --git a/site/docs/services/omvs/feedback-manager/overview.md b/site/docs/services/omvs/feedback-manager/overview.md
@@ -6,7 +6,7 @@ hide:
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/in-development.md"
+--8<-- "snippets/content-status/tech-preview.md"
 
 # Feedback Manager OMVS
 

diff --git a/site/docs/services/omvs/glossary-browser/overview.md b/site/docs/services/omvs/glossary-browser/overview.md
@@ -6,7 +6,7 @@ hide:
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/in-development.md"
+--8<-- "snippets/content-status/tech-preview.md"
 
 # Glossary Browser OMVS
 

diff --git a/site/docs/services/omvs/glossary-workflow/overview.md b/site/docs/services/omvs/glossary-workflow/overview.md
@@ -1,7 +1,7 @@
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/in-development.md"
+--8<-- "snippets/content-status/tech-preview.md"
 
 # Glossary Workflow OMVS
 

diff --git a/site/docs/services/omvs/governance-author/overview.md b/site/docs/services/omvs/governance-author/overview.md
@@ -6,7 +6,7 @@ hide:
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/in-development.md"
+--8<-- "snippets/content-status/tech-preview.md"
 
 # Governance Author Open Metadata View Service (OMVS)
 

diff --git a/site/docs/services/omvs/my-profile/overview.md b/site/docs/services/omvs/my-profile/overview.md
@@ -6,7 +6,7 @@ hide:
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/in-development.md"
+--8<-- "snippets/content-status/tech-preview.md"
 
 # My Profile OMVS
 

diff --git a/site/docs/services/omvs/project-manager/overview.md b/site/docs/services/omvs/project-manager/overview.md
@@ -6,7 +6,7 @@ hide:
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
 <!-- Copyright Contributors to the Egeria project. -->
 
---8<-- "snippets/content-status/in-development.md"
+--8<-- "snippets/content-status/tech-preview.md"
 
 # Project Manager OMVS
 

diff --git a/site/docs/types/0/0021-Collections.md b/site/docs/types/0/0021-Collections.md
@@ -53,8 +53,8 @@ The *HomeCollection* classification indicates that the collection is used to pro
 
 The *Folder* classification indicates that the collection is used to organize metadata elements.  The attributes are used to indicate to the caller how they should be displayed.
 
-* *orderBy* indicates the preferred ordering sequence. It uses the [OrderBy](#orderby-enumeration) enumeration.
-* *orderPropertyName* indicates which property to use if the *orderBy* attribute is set to `OTHER`.
+* *collectionOrder* indicates the preferred ordering sequence. It uses the [OrderBy](#orderby-enumeration) enumeration.
+* *orderByPropertyName* indicates which property to use if the *collectionOrder* attribute is set to `OTHER`.
 
 ### ResultsSet classification
 
@@ -88,7 +88,7 @@ The attributes for the *CollectionMembership* relationship establish the level o
 * The *stewardTypeName* attribute identifies the type of element (such as UserIdentity, Person, PersonRole) that is responsible for the correctness of this relationship.
 * The *stewardPropertyName* attribute identifies the property (such as guid or qualifiedName) used to identify the steward.
 * The *notes* attribute enables the steward to add additional information about this relationship.
-* The *status* attribute indicates the status of the member in the collection.  It is a [MembershipStatus](#membershipstatus-enumeration) value.
+* The *membershipStatus* attribute indicates the status of the member in the collection.  It is a [MembershipStatus](#membershipstatus-enumeration) value.
 * The *userDefinedStatus* provides a status value when *status=OTHER*.
 
 ## OrderBy enumeration
@@ -99,14 +99,14 @@ The attributes for the *CollectionMembership* relationship establish the level o
 * *DateUpdated* - Order by date that the asset was updated.
 * *DateCreated* - Order by date that the asset was created.
 * *Other* - Order by another property.
-* 
+
 ## MembershipStatus enumeration
 
 The values for the *MembershipStatus* enumeration are:
 
 * *Unknown* - The membership origin is unknown. This is the default value.
 * *Discovered* - The membership was discovered by an automated process.
-* *Assigned* - The membership was proposed by an expert curator.  The curator uses their expertise to create the membership. They may or may not be the steward who is ultimately accountable for the correctness of the membership.
+* *Proposed* - The membership was proposed by an expert curator.  The curator uses their expertise to create the membership. They may or may not be the steward who is ultimately accountable for the correctness of the membership.
 * *Imported* - The membership was imported from another metadata system.
 * *Validated* - The membership created by an automated process has been validated and approved by an expert curator.  Again, the curator may or may not be the steward.
 * *Deprecated* - The membership should no longer be used.

diff --git a/site/docs/types/0/0021-Collections.svg b/site/docs/types/0/0021-Collections.svg
diff --git a/site/docs/types/0/0030-Hosts-and-Platforms.svg b/site/docs/types/0/0030-Hosts-and-Platforms.svg