summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorgfraboni <gino.fraboni@amdocs.com>2017-09-06 09:35:58 -0400
committergfraboni <gino.fraboni@amdocs.com>2017-09-06 09:36:13 -0400
commit6860ae79165d36fefdd6b56d5a33eed0fb2d616e (patch)
treeb24c9fd70ba1c49ea38eb26c94971e476031fef1 /README.md
parentb1ab0f6ae4077d5d152a90523a0e55dd6ba5d5e6 (diff)
Add documentation for new edge endpoints.
Issue-ID: AAI-60 Change-Id: I04c0e0ca7895e5ef8f195d35cda71643b5fef10a Signed-off-by: gfraboni <gino.fraboni@amdocs.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md80
1 files changed, 80 insertions, 0 deletions
diff --git a/README.md b/README.md
index adb8bdb..2ad7ec2 100644
--- a/README.md
+++ b/README.md
@@ -473,6 +473,86 @@ Optionally, an edge can be created by posting to an endpoint which doesn't inclu
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/8400",
+ "target":"services/inventory/v8/pserver/40964272",
+ "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>