Dynamic API CDS content 85/85585/1
authorEzhilarasi <ezhrajam@in.ibm.com>
Wed, 17 Apr 2019 13:22:50 +0000 (18:52 +0530)
committerEzhilarasi <ezhrajam@in.ibm.com>
Wed, 17 Apr 2019 13:22:58 +0000 (18:52 +0530)
Change-Id: I8cf9f99641ef59610571ab5ae1c484ecae7b0a3f
Issue-ID: CCSDK-1221
Signed-off-by: Ezhilarasi <ezhrajam@in.ibm.com>
docs/dynamicapi.rst [new file with mode: 0644]

diff --git a/docs/dynamicapi.rst b/docs/dynamicapi.rst
new file mode 100644 (file)
index 0000000..eaf9987
--- /dev/null
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 IBM.
+
+Dynamic API
+-----------
+
+The nature of the API request and response is meant to be model driven and dynamic. They both share the same definition.
+
+The actionName, under the actionIdentifiers refers to the name of a Workflow (see workflow)
+
+The content of the payload is what is fully dynamic / model driven.
+
+The first top level element will always be either $actionName-request for a request or $actionName-response for a response.
+
+Then the content within this element is fully based on the workflow input and output.
+
+Here is how the a generic request and response look like.
+
+|image0|
+
+.. |image0| image:: media/dynamicapi.jpg
+   :height: 4.43750in
+   :width: 7.88889in
\ No newline at end of file