From 2b6cab52d322077662a625ebffc5eeec0718a82b Mon Sep 17 00:00:00 2001 From: Ezhilarasi Date: Mon, 26 Aug 2019 18:04:24 +0530 Subject: Formatted and fixed errors in DOC Change-Id: I613716d80cd6cf1bc9a4f4bb4cb38802cfe9e34d Issue-ID: CCSDK-1453 Signed-off-by: Ezhilarasi --- docs/datadictionary/create_netbox_ip_address.rst | 61 ++++++++-------- docs/datadictionary/dt-netbox-ip.rst | 33 +++++---- docs/datadictionary/resourcedefinitioncodesnip.rst | 83 +++++++++++----------- docs/microservices/bluePrintsProcessorMS.rst | 2 +- 4 files changed, 93 insertions(+), 86 deletions(-) (limited to 'docs') diff --git a/docs/datadictionary/create_netbox_ip_address.rst b/docs/datadictionary/create_netbox_ip_address.rst index 5d9a9be87..f17ddb407 100644 --- a/docs/datadictionary/create_netbox_ip_address.rst +++ b/docs/datadictionary/create_netbox_ip_address.rst @@ -5,32 +5,35 @@ create_netbox_ip_address code ============================= -{ - "tags" : "oam-local-ipv4-address", - "name" : "create_netbox_ip", - "property" : { - "description" : "netbox ip", - "type" : "dt-netbox-ip" - }, - "updated-by" : "adetalhouet", - "sources" : { - "primary-config-data" : { - "type" : "source-rest", - "properties" : { - "type" : "JSON", - "verb" : "POST", - "endpoint-selector" : "ipam-1", - "url-path" : "/api/ipam/prefixes/$prefixId/available-ips/", - "path" : "", - "input-key-mapping" : { - "prefixId" : "prefix-id" - }, - "output-key-mapping" : { - "address" : "address", - "id" : "id" - }, - "key-dependencies" : [ "prefix-id" ] - } - } - } - } \ No newline at end of file +.. code-block:: json + :linenos: + + { + "tags" : "oam-local-ipv4-address", + "name" : "create_netbox_ip", + "property" : { + "description" : "netbox ip", + "type" : "dt-netbox-ip" + }, + "updated-by" : "adetalhouet", + "sources" : { + "primary-config-data" : { + "type" : "source-rest", + "properties" : { + "type" : "JSON", + "verb" : "POST", + "endpoint-selector" : "ipam-1", + "url-path" : "/api/ipam/prefixes/$prefixId/available-ips/", + "path" : "", + "input-key-mapping" : { + "prefixId" : "prefix-id" + }, + "output-key-mapping" : { + "address" : "address", + "id" : "id" + }, + "key-dependencies" : [ "prefix-id" ] + } + } + } + } \ No newline at end of file diff --git a/docs/datadictionary/dt-netbox-ip.rst b/docs/datadictionary/dt-netbox-ip.rst index 9410580fb..6dc3c8464 100644 --- a/docs/datadictionary/dt-netbox-ip.rst +++ b/docs/datadictionary/dt-netbox-ip.rst @@ -5,18 +5,21 @@ dt-netbox-ip code ================= -{ - "version": "1.0.0", - "description": "This is Netbox IP Data Type", - "properties": { - "address": { - "required": true, - "type": "string" - }, - "id": { - "required": true, - "type": "integer" - } - }, - "derived_from": "tosca.datatypes.Root" -} +.. code-block:: none + :linenos: + + { + "version": "1.0.0", + "description": "This is Netbox IP Data Type", + "properties": { + "address": { + "required": true, + "type": "string" + }, + "id": { + "required": true, + "type": "integer" + } + }, + "derived_from": "tosca.datatypes.Root" + } diff --git a/docs/datadictionary/resourcedefinitioncodesnip.rst b/docs/datadictionary/resourcedefinitioncodesnip.rst index a91767678..6504a07c3 100644 --- a/docs/datadictionary/resourcedefinitioncodesnip.rst +++ b/docs/datadictionary/resourcedefinitioncodesnip.rst @@ -5,44 +5,45 @@ Source Capability Code ====================== -{ - "description": "This is Component Resource Source Node Type", - "version": "1.0.0", - "properties": { - "script-type": { - "required": true, - "type": "string", - "default": "kotlin", - "constraints": [ - { - "valid_values": [ - "kotlin", - "jython" - ] - } - ] - }, - "script-class-reference": { - "description": "Capability reference name for internal and kotlin, for jython script file path", - "required": true, - "type": "string" - }, - "instance-dependencies": { - "required": false, - "description": "Instance dependency Names to Inject to Kotlin / Jython Script.", - "type": "list", - "entry_schema": { - "type": "string" - } - }, - "key-dependencies": { - "description": "Resource Resolution dependency dictionary names.", - "required": true, - "type": "list", - "entry_schema": { - "type": "string" - } - } - }, - "derived_from": "tosca.nodes.ResourceSource" -} +.. code-block:: json + :linenos: + + "description": "This is Component Resource Source Node Type", + "version": "1.0.0", + "properties": { + "script-type": { + "required": true, + "type": "string", + "default": "kotlin", + "constraints": [ + { + "valid_values": [ + "kotlin", + "jython" + ] + } + ] + }, + "script-class-reference": { + "description": "Capability reference name for internal and kotlin, for jython script file path", + "required": true, + "type": "string" + }, + "instance-dependencies": { + "required": false, + "description": "Instance dependency Names to Inject to Kotlin / Jython Script.", + "type": "list", + "entry_schema": { + "type": "string" + } + }, + "key-dependencies": { + "description": "Resource Resolution dependency dictionary names.", + "required": true, + "type": "list", + "entry_schema": { + "type": "string" + } + } + }, + "derived_from": "tosca.nodes.ResourceSource" \ No newline at end of file diff --git a/docs/microservices/bluePrintsProcessorMS.rst b/docs/microservices/bluePrintsProcessorMS.rst index bd0b6997d..292f99e51 100644 --- a/docs/microservices/bluePrintsProcessorMS.rst +++ b/docs/microservices/bluePrintsProcessorMS.rst @@ -84,4 +84,4 @@ Testing the environment: Point your browser to http://localhost:8000/api/v1/execution-service/ping (please note that the port is 8000, not 8080) -To authenticate, use ccsdkapps / ccsdkapps as login / password. \ No newline at end of file +To authenticate, use login user id and password. \ No newline at end of file -- cgit 1.2.3-korg