aboutsummaryrefslogtreecommitdiffstats
path: root/docs/modelingconcepts
diff options
context:
space:
mode:
authorSarah Abouzainah <sabouzainah.ext@orange.com>2021-01-12 14:47:21 +0200
committerSingal, Kapil (ks220y) <ks220y@att.com>2021-01-19 14:40:02 -0500
commitf8c5f58ce8b2b076d5874508873829a33cc545b0 (patch)
tree9aea24972cf90dc4bf4afb6cf900cff1103d60fb /docs/modelingconcepts
parentb524bf9ec0f688e30a24f65758fd014e1e3aedce (diff)
Add new rst guide files
Issue-ID: CCSDK-3070 Issue-ID: CCSDK-3081 Signed-off-by: Sarah Abouzainah <sabouzainah.ext@orange.com> Change-Id: I25c2488ac1ad12966a357f11ecca6e630f440ec0
Diffstat (limited to 'docs/modelingconcepts')
-rw-r--r--docs/modelingconcepts/data-dictionary.rst48
-rw-r--r--docs/modelingconcepts/data-type.rst80
-rw-r--r--docs/modelingconcepts/dynamic-payload.rst66
-rw-r--r--docs/modelingconcepts/node-type.rst1
-rw-r--r--docs/modelingconcepts/workflow.rst5
5 files changed, 100 insertions, 100 deletions
diff --git a/docs/modelingconcepts/data-dictionary.rst b/docs/modelingconcepts/data-dictionary.rst
index bfc86d0c9..9f9699a05 100644
--- a/docs/modelingconcepts/data-dictionary.rst
+++ b/docs/modelingconcepts/data-dictionary.rst
@@ -84,28 +84,28 @@ Here is how input-key-mapping, output-key-mapping and key-dependencies can be us
* - vf-module-label data dictionary
* - .. code-block:: json
- {
- "name" : "vf-module-label",
- "tags" : "vf-module-label",
- "updated-by" : "adetalhouet",
- "property" : {
- "description" : "vf-module-label",
- "type" : "string"
- },
- "sources" : {
- "primary-db" : {
- "type" : "source-primary-db",
- "properties" : {
- "type" : "SQL",
- "query" : "select sdnctl.VF_MODULE_MODEL.vf_module_label as vf_module_label from sdnctl.VF_MODULE_MODEL where sdnctl.VF_MODULE_MODEL.customization_uuid=:customizationid",
- "input-key-mapping" : {
- "customizationid" : "vf-module-model-customization-uuid"
- },
- "output-key-mapping" : {
- "vf-module-label" : "vf_module_label"
- },
- "key-dependencies" : [ "vf-module-model-customization-uuid" ]
+ {
+ "name" : "vf-module-label",
+ "tags" : "vf-module-label",
+ "updated-by" : "adetalhouet",
+ "property" : {
+ "description" : "vf-module-label",
+ "type" : "string"
+ },
+ "sources" : {
+ "primary-db" : {
+ "type" : "source-primary-db",
+ "properties" : {
+ "type" : "SQL",
+ "query" : "select sdnctl.VF_MODULE_MODEL.vf_module_label as vf_module_label from sdnctl.VF_MODULE_MODEL where sdnctl.VF_MODULE_MODEL.customization_uuid=:customizationid",
+ "input-key-mapping" : {
+ "customizationid" : "vf-module-model-customization-uuid"
+ },
+ "output-key-mapping" : {
+ "vf-module-label" : "vf_module_label"
+ },
+ "key-dependencies" : [ "vf-module-model-customization-uuid" ]
+ }
+ }
}
- }
- }
- } \ No newline at end of file
+ } \ No newline at end of file
diff --git a/docs/modelingconcepts/data-type.rst b/docs/modelingconcepts/data-type.rst
index 29143de80..ee5908002 100644
--- a/docs/modelingconcepts/data-type.rst
+++ b/docs/modelingconcepts/data-type.rst
@@ -41,7 +41,7 @@ Users can **create** as many **data type** as needed.
To create a custom data-type you can use a POST call to CDS endpoint:
"<cds-ip>:<cds-port>/api/v1/model-type"
- .. code-block:: python
+ .. code-block:: json
:caption: **Payload:**
{
@@ -51,7 +51,7 @@ Users can **create** as many **data type** as needed.
"definition": {
"description": "<description>",
"version": "<version-number: eg 1.0.0>",
- "properties": {<add properties of your custom data type in JSON format>},
+ "properties": "code-block::{<add properties of your custom data type in JSON format>}",
"derived_from": "tosca.datatypes.Root"
},
"description": "<description",
@@ -111,44 +111,44 @@ List of existing data type:
.. code-block:: json
:caption: **datatype-resource-assignment**
- {
- "version": "1.0.0",
- "description": "This is Resource Assignment Data Type",
- "properties": {
- "property": {
- "required": true,
- "type": "datatype-property"
- },
- "input-param": {
- "required": true,
- "type": "boolean"
- },
- "dictionary-name": {
- "required": false,
- "type": "string"
- },
- "dictionary-source": {
- "required": false,
- "type": "string"
- },
- "dependencies": {
- "required": true,
- "type": "list",
- "entry_schema": {
- "type": "string"
- }
- },
- "updated-date": {
- "required": false,
- "type": "string"
- },
- "updated-by": {
- "required": false,
- "type": "string"
- }
- },
- "derived_from": "tosca.datatypes.Root"
- }
+ {
+ "version": "1.0.0",
+ "description": "This is Resource Assignment Data Type",
+ "properties": {
+ "property": {
+ "required": true,
+ "type": "datatype-property"
+ },
+ "input-param": {
+ "required": true,
+ "type": "boolean"
+ },
+ "dictionary-name": {
+ "required": false,
+ "type": "string"
+ },
+ "dictionary-source": {
+ "required": false,
+ "type": "string"
+ },
+ "dependencies": {
+ "required": true,
+ "type": "list",
+ "entry_schema": {
+ "type": "string"
+ }
+ },
+ "updated-date": {
+ "required": false,
+ "type": "string"
+ },
+ "updated-by": {
+ "required": false,
+ "type": "string"
+ }
+ },
+ "derived_from": "tosca.datatypes.Root"
+ }
.. tab:: property
diff --git a/docs/modelingconcepts/dynamic-payload.rst b/docs/modelingconcepts/dynamic-payload.rst
index f9c8157d4..d5a2976a4 100644
--- a/docs/modelingconcepts/dynamic-payload.rst
+++ b/docs/modelingconcepts/dynamic-payload.rst
@@ -23,45 +23,45 @@ Here is how the a **generic request** and **response** look like.
- response
* - .. code-block:: json
- {
- "commonHeader": {
- "originatorId": "",
- "requestId": "",
- "subRequestId": ""
- },
- "actionIdentifiers": {
- "blueprintName": "",
- "blueprintVersion": "",
- "actionName": "",
- "mode": ""
- },
- "payload": {
- "$actionName-request": {
- "$actionName-properties": {
+ {
+ "commonHeader": {
+ "originatorId": "",
+ "requestId": "",
+ "subRequestId": ""
+ },
+ "actionIdentifiers": {
+ "blueprintName": "",
+ "blueprintVersion": "",
+ "actionName": "",
+ "mode": ""
+ },
+ "payload": {
+ "$actionName-request": {
+ "$actionName-properties": {
+ }
+ }
}
}
- }
- }
- .. code-block:: json
- {
- "commonHeader": {
- "originatorId": "",
- "requestId": "",
- "subRequestId": ""
- },
- "actionIdentifiers": {
- "blueprintName": "",
- "blueprintVersion": "",
- "actionName": "",
- "mode": ""
- },
- "payload": {
- "$actionName-response": {
+ {
+ "commonHeader": {
+ "originatorId": "",
+ "requestId": "",
+ "subRequestId": ""
+ },
+ "actionIdentifiers": {
+ "blueprintName": "",
+ "blueprintVersion": "",
+ "actionName": "",
+ "mode": ""
+ },
+ "payload": {
+ "$actionName-response": {
+ }
+ }
}
- }
- }
The ``actionName``, under the ``actionIdentifiers`` refers to the name of a
Workflow (see :ref:`workflow`)
diff --git a/docs/modelingconcepts/node-type.rst b/docs/modelingconcepts/node-type.rst
index 070f6f65c..034a6b063 100644
--- a/docs/modelingconcepts/node-type.rst
+++ b/docs/modelingconcepts/node-type.rst
@@ -965,7 +965,6 @@ listed in the other section.
.. code-block:: json
:caption: **vnf-netconf-device**
-
{
"description": "This is VNF Device with Netconf Capability",
"version": "1.0.0",
diff --git a/docs/modelingconcepts/workflow.rst b/docs/modelingconcepts/workflow.rst
index f76fdea96..7e21cfe0c 100644
--- a/docs/modelingconcepts/workflow.rst
+++ b/docs/modelingconcepts/workflow.rst
@@ -250,9 +250,10 @@ Properties of a workflow
:caption: **dynamic input**
"resource-assignment-properties": {
- "required": true,
- "type": "dt-resource-assignment-properties"
+ "required": true,
+ "type": "dt-resource-assignment-properties"
}
+
* - outputs
- | Defines the outputs of the execution; there can be as many output as needed.
| Depending on the Component (see :ref:`node_type` -> Component) of use, some attribute might be retrievable.