Merge pull request #797 from MihaiIliescu/add_missing_documentation_a…

…sset_lineage Promote Asset Lineage to Tech Preview
odpi · Jun 19, 2023 · b88b495 · b88b495
2 parents 9f5a89c + 68cb096
commit b88b495
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/site/docs/services/omas/asset-lineage/overview.md b/site/docs/services/omas/asset-lineage/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"
 
 # Asset Lineage Open Metadata Access Service (OMAS)
 
@@ -122,25 +122,31 @@ Entity events to feed the changes assets that are crated or updated:
         }
     }
     ```
-### REST API
+## REST API
 
+### Publish Entity
+Find the entity by guid and publish the context for it
 !!! get "GET - Request lineage publish out for single entity (asset or term)"
 
     ```
     {{platformURLRoot}}/servers/{{serverName}}/open-metadata/access-services/asset-lineage/users/{{userId}}/publish-entity/{{entityTypeName}}/{{guid}}
     ```
-
+### Publish Entities
+Scan the cohort based on the given entity type and publish the contexts for the found entities to the out topic.
 !!! get "GET - Request lineage publish out for entity type (asset or term)"
 
     ```
     {{platformURLRoot}}/servers/{{serverName}}/open-metadata/access-services/asset-lineage/users/{{userId}}/publish-entities/{{entityTypeName}}
     ```
-
+### Publish Context
+Find the entity by guid and publish the asset context for it. It applies for data tables and files.
 !!! get "GET - Request asset context"
 
     ```
     {{platformURLRoot}}/servers/{{serverName}}/open-metadata/access-services/asset-lineage/users/{{userId}}/publish-context/{{entityTypeName}}/{{guid}}
     ```
+### Out Topic Connection
+Return the connection object for the Asset Lineage's OMAS's out topic.
 !!! get "GET - Output topic OCF connection"
     ```
     {{platformURLRoot}}/servers/{{serverName}}/open-metadata/access-services/asset-lineage/users/{{userId}}/topics/out-topic-connection/{callerId}

diff --git a/site/docs/types/0/0042-Software-Capabilities.md b/site/docs/types/0/0042-Software-Capabilities.md
@@ -58,6 +58,10 @@ Defines the relationship between a *SoftwareCapability* and the *ITInfrastructur
 Defines a classification for a *SoftwareCapability*. The *ProcessingState* can be used to describe additional runtime processing information used by various SoftwareCapabilities.
 
 
+## ProcessingState
+
+Defines a classification for a `SoftwareCapability`. It stores the last sync timestamp for critical elements. 
+
 ??? deprecated "Deprecated types"
     - *SoftwareServerSupportedCapability* is deprecated in favor of *SupportedSoftwareCapability*.