Updated Postman samples aligned to Egeria core docs

Signed-off-by: Christopher Grote <[email protected]>
odpi · Nov 5, 2019 · 5afa9de · 5afa9de
1 parent f50b4d6
commit 5afa9de
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 72 deletions.
diff --git a/samples/Egeria Atlas Connector.postman_environment.json b/samples/Egeria Atlas Connector.postman_environment.json
diff --git a/...as repo connector.postman_collection.json → ...ache-Atlas-config.postman_collection.json b/...as repo connector.postman_collection.json → ...ache-Atlas-config.postman_collection.json
@@ -1,7 +1,7 @@
 {
 	"info": {
 		"_postman_id": "78bb3df9-b4fa-4568-8eb9-5555610a284c",
-		"name": "Egeria Atlas repo connector",
+		"name": "Egeria-Apache-Atlas-config",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 	},
 	"item": [

diff --git a/... Atlas READ tests.postman_collection.json → ...Apache-Atlas-read.postman_collection.json b/... Atlas READ tests.postman_collection.json → ...Apache-Atlas-read.postman_collection.json
@@ -1,7 +1,7 @@
 {
 	"info": {
 		"_postman_id": "0a7b6a12-da4b-4e87-9dec-77a50b8565a7",
-		"name": "Egeria Atlas READ tests",
+		"name": "Egeria-Apache-Atlas-read",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
 	},
 	"item": [

diff --git a/samples/README.md b/samples/README.md
@@ -1,11 +1,16 @@
 <!-- SPDX-License-Identifier: Apache-2.0 -->
 <!-- Copyright Contributors to the ODPi Egeria project. -->
 
-# Egeria Atlas Connector.postman_environment.json
+# Samples
 
-Provides an example environment definition, with all the variables needed pre-defined (you simply need to provide values specific to your own environment).
+These sample Postman collections illustrate configuring and using the Apache Atlas connector
+for ODPi Egeria.
 
-# Egeria Atlas repo connector.postman_collection.json
+Each should be used with the
+[environment defined in the Egeria Core samples](https://github.com/odpi/egeria/blob/master/open-metadata-resources/open-metadata-samples/postman-rest-samples/README.md),
+which has all of the needed variables defined within it.
+
+# Egeria-Apache-Atlas-config.postman_collection.json
 
 This script can be used to configure Egeria for use with an existing Apache Atlas environment.
 
@@ -14,13 +19,8 @@ Prerequisites:
 - an existing Apache Atlas environment, ideally running v2
 - Kafka running and connected to the Apache Atlas environment (eg. the embedded Kafka)
 
-Variables:
+Apache Atlas-specific variables:
 
-- `baseURL` the egeria URL
-- `user` the userName to pass to Egeria
-- `server` the server name for Egeria
-- `cohort` the name of the cohort: used as the Kafka topic name for OMRS
-- `kafkaep` Kafka endpoint for the cohort
 - `atlas_host` the hostname (or IP address) of the existing Apache Atlas environment (web tier)
 - `atlas_port` the port number of the web console of the existing Apache Atlas environment
 - `atlas_user` the username of a user to access Atlas's REST API
@@ -29,7 +29,7 @@ Variables:
 
 Each step is sequentially numbered so that they can be executed in-order as part of a Postman "Runner", if desired.
 
-# Egeria Atlas READ tests.postman_collection.json
+# Egeria-Apache-Atlas-read.postman_collection.json
 
 This script can be used to run through a number of different tests of the connector, assuming the Apache Atlas
 environment has first been populated with the Glossary samples provided and those included in the Hortonworks Sandbox.
@@ -38,7 +38,7 @@ Prerequisites:
 
 - an existing Apache Atlas environment, ideally running v2
 - samples loaded
-- connector configured (eg. using `Egeria Atlas repo connector.postman_collection.json` above)
+- connector configured (eg. using `Egeria-Apache-Atlas-config.postman_collection.json` above)
 
 ----
 License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),