Merge "Add readthedocs documentation for sli/northbound"

2 files changed, 224 insertions, 77 deletions

diff --git a/dataChange/model/pom.xml b/dataChange/model/pom.xml
index 20dddeb9..5f7101cd 100755
--- a/dataChange/model/pom.xml
+++ b/dataChange/model/pom.xml
@@ -1,82 +1,93 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-	<modelVersion>4.0.0</modelVersion>
-	<parent>
-		<artifactId>dataChange</artifactId>
-		<groupId>org.onap.ccsdk.sli.northbound</groupId>
-		<version>0.1.0-SNAPSHOT</version>
-	</parent>
-	<groupId>org.onap.ccsdk.sli.northbound</groupId>
-	<artifactId>dataChange-model</artifactId>
-	<version>0.1.0-SNAPSHOT</version>
-	<packaging>bundle</packaging>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <artifactId>dataChange</artifactId>
+        <groupId>org.onap.ccsdk.sli.northbound</groupId>
+        <version>0.1.0-SNAPSHOT</version>
+    </parent>
+    <groupId>org.onap.ccsdk.sli.northbound</groupId>
+    <artifactId>dataChange-model</artifactId>
+    <version>0.1.0-SNAPSHOT</version>
+    <packaging>bundle</packaging>
 
 
-	<build>
-		<plugins>
-			<plugin>
-				<groupId>org.apache.felix</groupId>
-				<artifactId>maven-bundle-plugin</artifactId>
-                                <extensions>true</extensions>
-                                <configuration>
-                                        <instructions>
-                                                <Import-Package>*</Import-Package>
-                                        </instructions>
-                                </configuration>
-			</plugin>
-			<plugin>
-				<groupId>org.opendaylight.yangtools</groupId>
-				<artifactId>yang-maven-plugin</artifactId>
-				<version>${odl.yangtools.yang.maven.plugin.version}</version>
-				<dependencies>
-					<dependency>
-						<groupId>org.opendaylight.mdsal</groupId>
-						<artifactId>maven-sal-api-gen-plugin</artifactId>
-						<version>${odl.sal.api.gen.plugin.version}</version>
-						<type>jar</type>
-					</dependency>
-				</dependencies>
-				<executions>
-					<execution>
-						<goals>
-							<goal>generate-sources</goal>
-						</goals>
-						<configuration>
-							<yangFilesRootDir>${yang.file.directory}</yangFilesRootDir>
-							<codeGenerators>
-								<generator>
-									<codeGeneratorClass>org.opendaylight.mdsal.binding.maven.api.gen.plugin.CodeGeneratorImpl</codeGeneratorClass>
-									<outputBaseDir>${salGeneratorPath}</outputBaseDir>
-								</generator>
-							</codeGenerators>
-							<inspectDependencies>true</inspectDependencies>
-						</configuration>
-					</execution>
-				</executions>
-			</plugin>
-		</plugins>
-	</build>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+                <extensions>true</extensions>
+                <configuration>
+                    <instructions>
+                        <Import-Package>*</Import-Package>
+                    </instructions>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.opendaylight.yangtools</groupId>
+                <artifactId>yang-maven-plugin</artifactId>
+                <version>${odl.yangtools.yang.maven.plugin.version}</version>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.opendaylight.mdsal</groupId>
+                        <artifactId>maven-sal-api-gen-plugin</artifactId>
+                        <version>${odl.sal.api.gen.plugin.version}</version>
+                        <type>jar</type>
+                    </dependency>
+                    <dependency>
+                        <groupId>org.opendaylight.netconf</groupId>
+                        <artifactId>sal-rest-docgen-maven</artifactId>
+                        <version>${odl.restconf.version}</version>
+                        <type>jar</type>
+                    </dependency>
+                </dependencies>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>generate-sources</goal>
+                        </goals>
+                        <configuration>
+                            <yangFilesRootDir>${yang.file.directory}</yangFilesRootDir>
+                            <codeGenerators>
+                                <generator>
+                                    <codeGeneratorClass>org.opendaylight.mdsal.binding.maven.api.gen.plugin.CodeGeneratorImpl</codeGeneratorClass>
+                                    <outputBaseDir>${salGeneratorPath}</outputBaseDir>
+                                </generator>
+                                <generator>
+                                    <codeGeneratorClass>org.opendaylight.netconf.sal.rest.doc.maven.StaticDocGenerator</codeGeneratorClass>
+                                    <outputBaseDir>target/swagger</outputBaseDir>
+                                </generator>
+                            </codeGenerators>
+                            <inspectDependencies>true</inspectDependencies>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 
-	<dependencies>
-		<dependency>
-			<groupId>org.opendaylight.mdsal</groupId>
-			<artifactId>yang-binding</artifactId>
-			<version>${odl.mdsal.yang.binding.version}</version>
-		</dependency>
-		<dependency>
-			<groupId>org.opendaylight.yangtools</groupId>
-			<artifactId>yang-common</artifactId>
-			<version>${odl.yangtools.version}</version>
-		</dependency>
-		<dependency>
-			<groupId>org.opendaylight.mdsal.model</groupId>
-			<artifactId>ietf-inet-types</artifactId>
-			<version>${odl.ietf-inet-types.version}</version>
-		</dependency>
-		<dependency>
-			<groupId>org.opendaylight.mdsal.model</groupId>
-			<artifactId>ietf-yang-types</artifactId>
-			<version>${odl.ietf-yang-types.version}</version>
-		</dependency>
-	</dependencies>
+    <dependencies>
+        <dependency>
+            <groupId>org.opendaylight.mdsal</groupId>
+            <artifactId>yang-binding</artifactId>
+            <version>${odl.mdsal.yang.binding.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.opendaylight.yangtools</groupId>
+            <artifactId>yang-common</artifactId>
+            <version>${odl.yangtools.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.opendaylight.mdsal.model</groupId>
+            <artifactId>ietf-inet-types</artifactId>
+            <version>${odl.ietf-inet-types.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.opendaylight.mdsal.model</groupId>
+            <artifactId>ietf-yang-types</artifactId>
+            <version>${odl.ietf-yang-types.version}</version>
+        </dependency>
+    </dependencies>
 </project>
diff --git a/dataChange/model/src/main/resources/dataChange.20150519.json b/dataChange/model/src/main/resources/dataChange.20150519.json
new file mode 100644
index 00000000..128195b5
--- /dev/null
+++ b/dataChange/model/src/main/resources/dataChange.20150519.json
@@ -0,0 +1,136 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0"
+  },
+  "basePath": "/restconf",
+  "paths": {
+    "/operations/DataChange:data-change-notification": {
+      "post": {
+        "consumes": [
+          "application/json",
+          "application/xml"
+        ],
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "body",
+            "required": false,
+            "schema": {
+              "$ref": "#/definitions/(data-change-notification)input-TOP"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(data-change-notification)output-TOP"
+            }
+          }
+        },
+        "operationId": "data-change-notification"
+      }
+    }
+  },
+  "definitions": {
+    "(config)DataChange_modulePOST": {
+      "type": "object"
+    },
+    "(config)key-dataPOST": {
+      "properties": {
+        "key-name": {
+          "$ref": "#/definitions/Some key-name"
+        },
+        "key-value": {
+          "$ref": "#/definitions/Some key-value"
+        }
+      },
+      "type": "object"
+    },
+    "(data-change-notification)input": {
+      "properties": {
+        "DataChange:aai-event-id": {
+          "$ref": "#/definitions/Some aai-event-id"
+        },
+        "DataChange:aai-event-trigger": {
+          "$ref": "#/definitions/Update",
+          "enum": [
+            "Update",
+            "Delete"
+          ]
+        },
+        "DataChange:aai-node-type": {
+          "$ref": "#/definitions/Some aai-node-type"
+        },
+        "DataChange:key-data": {
+          "items": {
+            "$ref": "#/definitions/DataChange(config)key-data"
+          },
+          "type": "array"
+        },
+        "DataChange:selflink": {
+          "$ref": "#/definitions/Some selflink"
+        }
+      },
+      "type": "object"
+    },
+    "(data-change-notification)input-TOP": {
+      "properties": {
+        "DataChange:input": {
+          "items": {
+            "$ref": "#/definitions/(data-change-notification)input"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "(data-change-notification)output": {
+      "properties": {
+        "DataChange:data-change-response-code": {
+          "$ref": "#/definitions/Some data-change-response-code"
+        }
+      },
+      "type": "object"
+    },
+    "(data-change-notification)output-TOP": {
+      "properties": {
+        "DataChange:output": {
+          "items": {
+            "$ref": "#/definitions/(data-change-notification)output"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "DataChange(config)key-data": {
+      "properties": {
+        "DataChange:key-name": {
+          "$ref": "#/definitions/Some key-name"
+        },
+        "DataChange:key-value": {
+          "$ref": "#/definitions/Some key-value"
+        }
+      },
+      "type": "object"
+    },
+    "DataChange(config)key-data-TOP": {
+      "properties": {
+        "DataChange:key-data": {
+          "items": {
+            "$ref": "#/definitions/DataChange(config)key-data"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "unique_empty_identifier": {}
+  }
+}