aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEzhilarasi <ezhrajam@in.ibm.com>2019-08-19 20:44:09 +0530
committerEzhilarasi R <ezhrajam@in.ibm.com>2019-08-21 13:59:24 +0000
commitaec702437357b37e3c8de5d7042473fe2952fe82 (patch)
tree1d44219f1b5afb600510e37fd19d407682187225 /docs
parent45f09e768722282391c2ea82894ac148ca9a8918 (diff)
Fixed warnings and errors in Doc
Fixed errors in read the docs page Change-Id: Id5ccdd2049d71d5099de5537b0799bb5dfc7124c Issue-ID: CCSDK-1453 Signed-off-by: Ezhilarasi <ezhrajam@in.ibm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/datadictionary/complexResponse.rst27
-rw-r--r--docs/datadictionary/dbsystemcode.rst16
-rw-r--r--docs/datadictionary/index.rst2
-rw-r--r--docs/datadictionary/restauth.rst74
4 files changed, 67 insertions, 52 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/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/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/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