Update README

Add description of new Bulk API to README

Issue-ID: AAI-482
Change-Id: Icd5c39282644986f5677f67fa1101c54d8ee56f7
Signed-off-by: sblimkie <steven.blimkie@amdocs.com>

1 files changed, 11 insertions, 601 deletions

diff --git a/README.md b/README.md
index fb959a4..75bdde5 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-runsOnPserverrunsOnPserver# CRUD Microservice (Gizmo)
+# CRUD Microservice (Gizmo)
 
 ## Overview
 The CRUD microservice implements a set of RESTful APIs which allow a client to perform CREATE, UPDATE, GET, and DELETE operations on verticies and edges within the A&AI graph database.
@@ -108,609 +108,19 @@ Where,
 	Method: GET
 	Success Response: 200
 	
-### Create Vertex
+### Vertex APIs
+Gizmo exposes a set of APIs to operate on verticies within the graph. 
+[Vertex APIs](./VERTEX.md)
 
-Vertex payload data is validated against oxm.
-* Mandatory attributes are required in payload
-* Data type validation is enforced
-* Defaults from oxm schema used when not specified in payload
+### Edge APIs
+Gizmo exposes a set of APIs to operate on edges within the graph. 
+[Edge APIs](./EDGE.md)
 
-	URL: https://<host>:9520/services/inventory/v8/pserver/
-	Method: POST
-	Body:
-		{   
-			"properties":{   
-				"ptnii-equip-name":"e-name",
-				"equip-type":"server",
-				"hostname":"myhost",
-				"equip-vendor":"HP",
-				"equip-model":"DL380p-nd",
-				"fqdn":myhost.onap.net",
-				"purpose":"my-purpose",
-				"resource-version":"1477013499",
-				"ipv4-oam-address":"1.2.3.4"
-			}
-		}
-	Success	Response:
-		Code: 201
-		Content:
-			{   
-				"id":"1130672",
-				"type":"pserver",
-				"url":"services/inventory/v8/pserver/1130672",
-				"properties":{   
-					"ptnii-equip-name":"e-name",
-					"equip-type":"server",
-					"hostname":"myhost",
-					"equip-vendor":"HP",
-					"equip-model":"DL380p-nd",
-					"fqdn":myhost.onap.net",
-					"purpose":"my-purpose",
-					"resource-version":"1477013499",
-					"ipv4-oam-address":"1.2.3.4"
-				}
-			}	
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
+### Bulk API
+Gizmo exposes a bulk API to operate on multiple graph entities within a single request. 
+[Bulk API](./BULK.md)
+     
 
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
 
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
-
-Optionally, a vertex can be created by posting to an endpoint which doesn't include the vertex type.
-
-	URL: https://<host>:9520/services/inventory/v8/
-	Method: POST
-	Body:
-		{   
-			"type":"pserver",
-			"properties":{   
-				"ptnii-equip-name":"e-name",
-				"equip-type":"server",
-				"hostname":"myhost",
-				"equip-vendor":"HP",
-				"equip-model":"DL380p-nd",
-				"fqdn":myhost.onap.net",
-				"purpose":"my-purpose",
-				"resource-version":"1477013499",
-				"ipv4-oam-address":"1.2.3.4"
-			}
-		}
-	Success	Response:
-		Code: 201
-		Content:
-			{   
-				"id":"1130672",
-				"type":"pserver",
-				"url":"services/inventory/v8/pserver/1130672",
-				"properties":{   
-					"ptnii-equip-name":"e-name",
-					"equip-type":"server",
-					"hostname":"myhost",
-					"equip-vendor":"HP",
-					"equip-model":"DL380p-nd",
-					"fqdn":myhost.onap.net",
-					"purpose":"my-purpose",
-					"resource-version":"1477013499",
-					"ipv4-oam-address":"1.2.3.4"
-				}
-			}	
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
- 
-### Get Vertex
-
-	URL: https://<host>:9520/services/inventory/v8/pserver/<id>
-	Method: GET
-	Success	Response:
-		Code: 200
-		Content:
-			{   
-				"id":"1130672",
-				"type":"pserver",
-				"url":"services/inventory/v8/pserver/<id>",
-				"properties":{   
-					"ptnii-equip-name":"e-name",
-					"equip-type":"server",
-					"hostname":"myhost",
-					"equip-vendor":"HP",
-					"equip-model":"DL380p-nd",
-					"fqdn":myhost.onap.net",
-					"purpose":"my-purpose",
-					"resource-version":"1477013499",
-					"ipv4-oam-address":"1.2.3.4"
-				},
-				"in":[   
-				],
-				"out":[   
-					{   
-						"id":"1crwnu-6hc-d6vp-oe08g",
-						"type":"has",
-						"target":"services/inventory/v8/vserver/40964272",
-						"url":"services/inventory/relationships/v8/has/1crwnu-6hc-d6vp-oe08g"
-					}
-				]
-			}	
-	Error Response:
-		Code: 404 (NOT FOUND)
-		Situation: Resource Not found
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
-
-### Get Vertices
-
-	URL: https://<host>:9520/services/inventory/v8/pserver/
-	Optional Query Param: ?equip-vendor=HP
-	Method: GET
-	Success	Response:
-		Code: 200
-		Content:
-			[   
-				{   
-					"id":"950296",
-					"type":"pserver",
-					"url":"services/inventory/v8/pserver/950296"
-				},
-				{   
-					"id":"1126576",
-					"type":"pserver",
-					"url":"services/inventory/v8/pserver/1126576"
-				},
-				{   
-					"id":"1032384",
-					"type":"pserver",
-					"url":"services/inventory/v8/pserver/1032384"
-				}
-			]	
-	Error Response:
-		Code: 404 (NOT FOUND)
-		Situation: Resource Not found
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.		
-
-### Update Vertex
-
-The PUT command is used to modify an existing vertex.  By default, the vertex data is replaced by the content of the payload.  However, teh following parameter can be added to the header to perform a PATCH instead of a replace:
-**X-HTTP-Method-Override=Patch**
-
-	URL: https://<host>:9520/services/inventory/v8/pserver/<id>
-	Method: PUT
-	Body: Same as POST	
-	Success	Response:
-		Code: 201
-		Content: Same as POST	
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
-
-### Patch Vertex
-
-	URL: https://<host>:9520/services/inventory/v8/pserver/<id>
-	Method: PATCH (Content-Type header set to application/merge-patch+json)
-	Body:
-		{   
-			"properties":{   
-				"ptnii-equip-name":"e-name",
-				"resource-version":"1477013499",
-				"ipv4-oam-address":"1.2.3.99"
-			}
-		}
-	Success	Response:
-		Code: 200
-		Content: Same as POST		
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
- 
- ### Delete Vertex
-
-	URL: https://<host>:9520/services/inventory/v8/pserver/<id>
-	Method: DELETE
-	Success	Response:
-		Code: 200		
-	Error Response:
-		Code: 404 (NOT FOUND)
-		Situation: Resource not found
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
-
-### Create Edge
-
-When creating an edge, the CRUD service will validate:
-* properties match the defined schema
-* relationship is valid between the source and target
-
-	URL: https://<host>:9520/services/inventory/relationships/v8/runsOnPserver/
-	Method: POST
-	Body:
-		{     
-			"source":"services/inventory/v8/vserver/0",
-			"target":"services/inventory/v8/pserver/7",
-			"properties":{   
-				"multiplicity":"many",
-				"is-parent":true,
-				"uses-resource":"true",
-				"has-del-target":"true"
-			}
-		}
-	Success	Response:
-		Code: 201
-		Content:
-			{   
-				"id":"215x5m-6hc-d6vp-oe08g",
-				"type":"runsOnPserver",
-				"url":"services/inventory/relationships/v8/has/215x5m-6hc-d6vp-oe08g",
-				"source":"services/inventory/v8/vserver/0",
-				"target":"services/inventory/v8/pserver/7",
-				"properties":{   
-					"is-parent":"true",
-					"multiplicity":"many",
-					"has-del-target":"true",
-					"uses-resource":"true"
-				}
-			}
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
-
-Optionally, an edge can be created by posting to an endpoint which doesn't include the edge type.
-
-	URL: https://<host>:9520/services/inventory/relationships/v8/
-	Method: POST
-	Body:
-		{    
-			"type":"runsOnPserver",
-			"source":"services/inventory/v8/vserver/0",
-			"target":"services/inventory/v8/pserver/7",
-			"properties":{   
-				"multiplicity":"many",
-				"is-parent":true,
-				"uses-resource":"true",
-				"has-del-target":"true"
-			}
-		}
-	Success	Response:
-		Code: 201
-		Content: Same as above	
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
- 
-### Create Edge With Auto-Population Of Edge Properties
-An alternate endpoint exists for creating edges which follows all of the conventions of the above endpoints, with the  addition that properties defined in the db edge rules produced by the A&AI will be automatically populated for the edge.
-
-	URL: https://<host>:9520/services/resources/relationships/runsOnPserver/
-	Method: POST
-	Body:
-		{     
-			"source":"services/inventory/v8/vserver/0",
-			"target":"services/inventory/v8/pserver/7",
-			"properties":{   
-
-			}
-		}
-	Success	Response:
-		Code: 201
-		Content:
-			{   
-				"id":"215x5m-6hc-d6vp-oe08g",
-				"type":"runsOnPserver",
-				"url":"services/inventory/relationships/v8/has/215x5m-6hc-d6vp-oe08g",
-				"source":"services/inventory/v8/vserver/0",
-				"target":"services/inventory/v8/pserver/7",
-				"properties":{   
-			        "contains-other-v": "NONE",
-			        "delete-other-v": "NONE",
-			        "SVC-INFRA": "OUT",
-			        "prevent-delete": "IN"
-				}
-			}
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
- 
-The same option to POST to an endpoint without specifying a type in the URL exists for this endpoint as well:
-
-	URL: https://<host>:9520/services/resources/relationships/
-	Method: POST
-	Body:
-		{    
-			"type":"runsOnPserver",
-			"source":"services/inventory/v8/vserver/0",
-			"target":"services/inventory/v8/pserver/7",
-			"properties":{   
-				"multiplicity":"many",
-				"is-parent":true,
-				"uses-resource":"true",
-				"has-del-target":"true"
-			}
-		}
-	Success	Response:
-		Code: 201
-		Content: Same as above	
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
-		
-### Get Edge
-
-	URL: https://<host>:9520/services/inventory/relationships/v8/runsOnPserver/<id>
-	Method: GET
-	Success	Response:
-		Code: 200
-		Content:
-			{   
-				"id":"215x5m-6hc-d6vp-oe08g",
-				"type":"runsOnPserver",
-				"url":"services/inventory/relationships/v8/has/215x5m-6hc-d6vp-oe08g",
-				"source":"services/inventory/v8/vserver/8400",
-				"target":"services/inventory/v8/pserver/40964272",
-				"properties":{   
-					"is-parent":"true",
-					"multiplicity":"many",
-					"has-del-target":"true",
-					"uses-resource":"true"
-				}
-			}	
-	Error Response:
-		Code: 404 (NOT FOUND)
-		Situation: Resource Not found
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
-
-### Get Edges
-
-	URL: https://<host>:9520/services/inventory/relationships/v8/runsOnPserver
-	Optional Query Param: ?multiplicity=many
-	Method: GET
-	Success	Response:
-		Code: 200
-		Content:
-			[   
-				{   
-					"id":"1crwnu-6hc-d6vp-oe08g",
-					"type":"runsOnPserver",
-					"url":"services/inventory/relationships/v8/runsOnPserver/1crwnu-6hc-d6vp-oe08g",
-					"source":"services/inventory/v8/vserver/8400",
-					"target":"services/inventory/v8/pserver/40964272"
-				},
-				{   
-					"id":"215x5m-6hc-d6vp-oe08g",
-					"type":"runsOnPserver",
-					"url":"services/inventory/relationships/v8/runsOnPserver/215x5m-6hc-d6vp-oe08g",
-					"source":"services/inventory/v8/vserver/8400",
-					"target":"services/inventory/v8/pserver/40964272"
-				}
-			]
-	Error Response:
-		Code: 404 (NOT FOUND)
-		Situation: Resource Not found
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.		
-
-### Update Edge
-
-The PUT command is used to modify an existing edge.  By default, the edge data is replaced by the content of the payload.  However, the following parameter can be added to the header to perform a PATCH instead of a replace:
-**X-HTTP-Method-Override=Patch**
-
-	URL: https://<host>:9520/services/inventory/relationships/v8/runsOnPserver/<id>
-	Method: PUT
-	Body: (**Note that the source and target can not be modified)
-		{     
-			"properties":{   
-				"multiplicity":"many",
-				"is-parent":true,
-				"uses-resource":"true",
-				"has-del-target":"true"
-			}
-		}
-	Success	Response:
-		Code: 200
-		Content: Same as POST	
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
-
-### Patch Edge
-
-	URL: https://<host>:9520/services/inventory/relationships/v8/runsOnPserver/<id>
-	Method: PATCH (Content-Type header set to application/merge-patch+json)
-	Body:
-		{        
-			"properties":{   
-				"multiplicity":"many"
-			}
-		}
-	Success	Response:
-		Code: 200
-		Content: Same as POST		
-	Error Response:
-		Code: 400 (BAD REQUEST)
-		Content: Error message describing the bad request failure.
-		Situation: Invalid Payload or schema error.
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
- 
-### Delete Edge
-
-	URL: https://<host>:9520/services/inventory/relationships/v8/runsOnPserver/<id>
-	Method: DELETE
-	Success	Response:
-		Code: 200		
-	Error Response:
-		Code: 404 (NOT FOUND)
-		Situation: Resource not found
-
-		Code: 403 (FORBIDDEN)
-		Content: Error message describing the Authorization failure.
-		Situation: Authorization failure.
-
-		Code: 415 (UNSUPPORTED MEDIA TYPE)
-		Situation: Unsupported content type .
-		
-		Code: 500 (Internal Server Error)
-		Content: Error message describing the failure.
-		Situation: Any scenario not covered by the above error codes.
- 
  		
  
\ No newline at end of file