diff options
| author |   Dan Timoney <dtimoney@att.com> | 2019-04-19 00:25:29 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2019-04-19 00:25:29 +0000 |
| commit | 5da4b575a18c433b9a15e2ea68a6e11ccfa535e6 (patch) | |
| tree | 17b986c74342ba5c6d1a160379be82848c20fe60 | |
| parent | b6f5997c51bf9ad1e0cfd337bd5d12147bfb7058 (diff) | |
| parent | dc19d799e60b2f7c3837a4463ae13554b80aea22 (diff) | |
Merge "Dynamic API CDS content"
| -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 |