docs/microservices/dynamicapi.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2019 IBM.
   4
   5 Dynamic API
   6 ===========
   7
   8 The nature of the API request and response is meant to be model driven and dynamic. They both share the same definition.
   9
  10 The actionName, under the actionIdentifiers refers to the name of a Workflow (see workflow)
  11
  12 The content of the payload is what is fully dynamic / model driven.
  13
  14 The first top level element will always be either $actionName-request for a request or $actionName-response for a response.
  15
  16 Then the content within this element is fully based on the workflow input and output.
  17
  18 Here is how the a generic request and response look like.
  19
  20 |image0|
  21
  22 .. |image0| image:: media/dyanmicapi.jpg
  23    :width: 500pt