summaryrefslogtreecommitdiffstats
path: root/docs/datadictionary/resourcesource.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/datadictionary/resourcesource.rst')
-rw-r--r--docs/datadictionary/resourcesource.rst40
1 files changed, 37 insertions, 3 deletions
diff --git a/docs/datadictionary/resourcesource.rst b/docs/datadictionary/resourcesource.rst
index 2b60990ec..1bc0de4f1 100644
--- a/docs/datadictionary/resourcesource.rst
+++ b/docs/datadictionary/resourcesource.rst
@@ -49,14 +49,14 @@ CDS is currently deployed along the side of SDNC, hence the primary database con
.. toctree::
:maxdepth: 1
- sourceprimarydbcode
-
+sourceprimarydbcode
+
Connection to a specific database can be expressed through the endpoint-selector property, which refers to a macro defining the information about the database the connect to. Understand TOSCA Macro in the context of CDS.
.. toctree::
:maxdepth: 1
- dbsystemcode
+dbsystemcode
REST:
@@ -108,3 +108,37 @@ Expects a script to be provided.
:maxdepth: 1
sourcecapabilitycode
+
+Complex Type:
+=============
+
+Value will be resolved through REST., and output will be a complex type.
+
+Modeling reference: Modeling Concepts#rest
+
+In this example, we're making a POST request to an IPAM system with no payload.
+
+Some ingredients are required to perform the query, in this case, $prefixId. Hence It is provided as an input-key-mapping and defined as a key-dependencies. Please refer to the modeling guideline for more in depth understanding.
+
+As part of this request, the expected response will be as below.
+
+.. toctree::
+ :maxdepth: 1
+
+ complexResponse
+
+What is of interest is the address and id fields. For the process to return these two values, we need to create a custom data-type, as bellow
+
+.. toctree::
+ :maxdepth: 1
+
+ dt-netbox-ip
+
+The type of the data dictionary will be dt-netbox-ip.
+
+To tell the resolution framework what is of interest in the response, the output-key-mapping section is used. The process will map the output-key-mapping to the defined data-type.
+
+.. toctree::
+ :maxdepth: 1
+
+create_netbox_ip_address \ No newline at end of file