diff options
| author |   Ezhilarasi <ezhrajam@in.ibm.com> | 2019-04-17 18:52:50 +0530 |
|---|---|---|
| committer | Ezhilarasi <ezhrajam@in.ibm.com> | 2019-04-17 18:52:58 +0530 |
| commit | dc19d799e60b2f7c3837a4463ae13554b80aea22 (patch) | |
| tree | 5468773a84b6126e228f73d81d25ad4b52d77213 /docs | |
| parent | 569eaa5163b07d153c9b76195ecfd586bc84d7a7 (diff) | |
Dynamic API CDS content
Change-Id: I8cf9f99641ef59610571ab5ae1c484ecae7b0a3f
Issue-ID: CCSDK-1221
Signed-off-by: Ezhilarasi <ezhrajam@in.ibm.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dynamicapi.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/dynamicapi.rst b/docs/dynamicapi.rst new file mode 100644 index 000000000..eaf9987b7 --- /dev/null +++ b/docs/dynamicapi.rst @@ -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 |