diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/datadictionary/complexResponse.rst | 27 | ||||
| -rw-r--r-- | docs/datadictionary/create_netbox_ip_address.rst | 61 | ||||
| -rw-r--r-- | docs/datadictionary/dbsystemcode.rst | 16 | ||||
| -rw-r--r-- | docs/datadictionary/dt-netbox-ip.rst | 33 | ||||
| -rw-r--r-- | docs/datadictionary/index.rst | 2 | ||||
| -rw-r--r-- | docs/datadictionary/resourcedefinitioncodesnip.rst | 83 | ||||
| -rw-r--r-- | docs/datadictionary/restauth.rst | 74 | ||||
| -rw-r--r-- | docs/microservices/bluePrintsProcessorMS.rst | 2 |
8 files changed, 160 insertions, 138 deletions
diff --git a/docs/datadictionary/complexResponse.rst b/docs/datadictionary/complexResponse.rst index aa39ff235..d32d13de5 100644 --- a/docs/datadictionary/complexResponse.rst +++ b/docs/datadictionary/complexResponse.rst @@ -5,16 +5,17 @@ complex Response code ===================== -{ - "id": 4, - "address": "192.168.10.2/32", - "vrf": null, - "tenant": null, - "status": 1, - "role": null, - "interface": null, - "description": "", - "nat_inside": null, - "created": "2018-08-30", - "last_updated": "2018-08-30T14:59:05.277820Z" -} +.. code-block:: json + :linenos: + + "id": 4, + "address": "192.168.10.2/32", + "vrf": null, + "tenant": null, + "status": 1, + "role": null, + "interface": null, + "description": "", + "nat_inside": null, + "created": "2018-08-30", + "last_updated": "2018-08-30T14:59:05.277820Z"
\ No newline at end of file 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/dbsystemcode.rst b/docs/datadictionary/dbsystemcode.rst index 5051d1e7d..d6cda5b6c 100644 --- a/docs/datadictionary/dbsystemcode.rst +++ b/docs/datadictionary/dbsystemcode.rst @@ -4,12 +4,14 @@ Dbsystemcode ============ - -"dsl_definitions": { - "dynamic-db-source": { +.. code-block:: json + :linenos: + + "dsl_definitions": { + "dynamic-db-source": { "type": "maria-db", "url": "jdbc:mysql://localhost:3306/sdnctl", - "username": "sdnctl", - "password": "sdnctl" - } -}
\ No newline at end of file + "username": <username>, + "password": <password> + } + }
\ 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/index.rst b/docs/datadictionary/index.rst index 3ac8587ee..4039cca6d 100644 --- a/docs/datadictionary/index.rst +++ b/docs/datadictionary/index.rst @@ -40,7 +40,7 @@ Here is how input-key-mapping, output-key-mapping and key-dependencies can be us .. toctree:: :maxdepth: 1 - resourcedefinitioncodesnip + resourcedefinitioncodesnip Resource source: 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/datadictionary/restauth.rst b/docs/datadictionary/restauth.rst index 40c179375..9f628696c 100644 --- a/docs/datadictionary/restauth.rst +++ b/docs/datadictionary/restauth.rst @@ -7,36 +7,48 @@ Resource Rest Authentication ---------------------------- token-auth: - -"dsl_definitions": { - "dynamic-rest-source": { - "type" : "token-auth", - "url" : "http://localhost:32778", - "token" : "Token 0123456789abcdef0123456789abcdef01234567" - } -} - +~~~~~~~~~~~ + +.. code-block:: json + :linenos: + + "dsl_definitions": { + "dynamic-rest-source": { + "type" : "token-auth", + "url" : "http://localhost:32778", + "token" : <token> + } + } + basic-auth: - -"dsl_definitions": { - "dynamic-rest-source": { - "type" : "basic-auth", - "url" : "http://localhost:32778", - "username" : "bob", - "password": "marley" - } -} - +~~~~~~~~~~~ + +.. code-block:: json + :linenos: + + "dsl_definitions": { + "dynamic-rest-source": { + "type" : "basic-auth", + "url" : "http://localhost:32778", + "username" : <username>, + "password": <password> + } + } + ssl-basic-auth: - -"dsl_definitions": { - "dynamic-rest-source": { - "type" : "ssl-basic-auth", - "url" : "http://localhost:32778", - "keyStoreInstance": "JKS or PKCS12", - "sslTrust": "trusture", - "sslTrustPassword": "trustore password", - "sslKey": "keystore", - "sslKeyPassword: "keystore password" - } -}
\ No newline at end of file +~~~~~~~~~~~~~~~ + +.. code-block:: json + :linenos: + + "dsl_definitions": { + "dynamic-rest-source": { + "type" : "ssl-basic-auth", + "url" : "http://localhost:32778", + "keyStoreInstance": "JKS or PKCS12", + "sslTrust": "trusture", + "sslTrustPassword": <password>, + "sslKey": "keystore", + "sslKeyPassword: <password> + } + }
\ 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 |