diff options
author | Dan Timoney <dtimoney@att.com> | 2019-04-24 13:41:30 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2019-04-24 13:41:30 +0000 |
commit | e9e5d453a301d59cebb7e4a21c88dd2178e83207 (patch) | |
tree | 03910a85676d5df8f63e5c7b48256eeebcfd4e11 /docs | |
parent | 7cf8be22a575999dbb469079e3c6622fcd3ed3e7 (diff) | |
parent | 2efa5419540c7188669fb386685f4e5817a66a3f (diff) |
Merge "Added Complex type to Resource source"
Diffstat (limited to 'docs')
-rw-r--r-- | docs/datadictionary/resourcesource.rst | 40 |
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 |