Add readthedocs info to sli/core

Add additional information to sli/core readthedocs documentation.

Change-Id: I9fe5e6185061ed6a05f373b6667f686e11d5f0aa
Issue-ID: CCSDK-107
Signed-off-by: Dan Timoney <dtimoney@att.com>

2 files changed, 523 insertions, 4 deletions

diff --git a/sliapi/model/pom.xml b/sliapi/model/pom.xml
index fc9b7637..d36aaa13 100755
--- a/sliapi/model/pom.xml
+++ b/sliapi/model/pom.xml
@@ -33,6 +33,12 @@
 						<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>
@@ -43,12 +49,13 @@
 							<yangFilesRootDir>${yang.file.directory}</yangFilesRootDir>
 							<codeGenerators>
 								<generator>
-									<!--
-									<codeGeneratorClass>org.opendaylight.yangtools.maven.sal.api.gen.plugin.CodeGeneratorImpl</codeGeneratorClass>
-									-->
 									<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>
diff --git a/sliapi/model/src/main/resources/sli-api.20161110.json b/sliapi/model/src/main/resources/sli-api.20161110.json
index 0cc53fe9..da966e1e 100644
--- a/sliapi/model/src/main/resources/sli-api.20161110.json
+++ b/sliapi/model/src/main/resources/sli-api.20161110.json
@@ -1 +1,513 @@
-{"apiVersion":"1.0.0","swaggerVersion":"1.2","basePath":"restconf","resourcePath":null,"produces":["application/json","application/xml"],"apis":[{"path":"/config","operations":[{"method":"POST","summary":null,"notes":"Defines API to service logic interpreter","type":"(config)SLI-API_modulePOST","nickname":"POST-SLI-API_module","consumes":["application/json","application/xml"],"parameters":[{"name":"**(config)test-results","description":null,"required":false,"type":"SLI-API(config)test-results-TOP","paramType":"body"}],"responseMessages":null}]},{"path":"/config/SLI-API:test-results","operations":[{"method":"GET","summary":null,"notes":"Test results","type":"(config)test-results","nickname":"GET-test-results","consumes":null,"parameters":[],"responseMessages":null},{"method":"PUT","summary":null,"notes":"Test results","type":"SLI-API(config)test-results-TOP","nickname":"PUT-test-results","consumes":["application/json","application/xml"],"parameters":[{"name":"(config)test-results","description":null,"required":false,"type":"SLI-API(config)test-results-TOP","paramType":"body"}],"responseMessages":null},{"method":"DELETE","summary":null,"notes":"Test results","type":null,"nickname":"DELETE-test-results","consumes":null,"parameters":[],"responseMessages":null},{"method":"POST","summary":null,"notes":"Test results","type":"(config)test-resultsPOST","nickname":"POST-test-results","consumes":["application/json","application/xml"],"parameters":[{"name":"**(config)test-result","description":null,"required":false,"type":"SLI-API/test-results(config)test-result-TOP","paramType":"body"}],"responseMessages":null}]},{"path":"/config/SLI-API:test-results/test-result/{test-identifier}","operations":[{"method":"GET","summary":null,"notes":null,"type":"(config)test-result","nickname":"GET-test-result","consumes":null,"parameters":[{"name":"test-identifier","description":null,"required":false,"type":"string","paramType":"path"}],"responseMessages":null},{"method":"PUT","summary":null,"notes":null,"type":"SLI-API/test-results(config)test-result-TOP","nickname":"PUT-test-result","consumes":["application/json","application/xml"],"parameters":[{"name":"test-identifier","description":null,"required":false,"type":"string","paramType":"path"},{"name":"(config)test-result","description":null,"required":false,"type":"SLI-API/test-results(config)test-result-TOP","paramType":"body"}],"responseMessages":null},{"method":"DELETE","summary":null,"notes":null,"type":null,"nickname":"DELETE-test-result","consumes":null,"parameters":[{"name":"test-identifier","description":null,"required":false,"type":"string","paramType":"path"}],"responseMessages":null}]},{"path":"/operational/SLI-API:test-results","operations":[{"method":"GET","summary":null,"notes":"Test results","type":"(operational)test-results","nickname":"GET-test-results","consumes":null,"parameters":[],"responseMessages":null}]},{"path":"/operations/SLI-API:healthcheck","operations":[{"method":"POST","summary":null,"notes":null,"type":"(healthcheck)output-TOP","nickname":"healthcheck","consumes":["application/json","application/xml"],"parameters":[{"name":null,"description":null,"required":false,"type":"(healthcheck)input-TOP","paramType":"body"}],"responseMessages":null}]},{"path":"/operations/SLI-API:execute-graph","operations":[{"method":"POST","summary":null,"notes":" Method to add a new parameter.","type":"(execute-graph)output-TOP","nickname":"execute-graph","consumes":["application/json","application/xml"],"parameters":[{"name":null,"description":null,"required":false,"type":"(execute-graph)input-TOP","paramType":"body"}],"responseMessages":null}]}],"models":{"(execute-graph)output":{"$schema":"http://json-schema.org/draft-04/schema","id":"(execute-graph)output","type":"object","properties":{"SLI-API:response-code":{"type":"Some response-code","required":false},"SLI-API:ack-final-indicator":{"type":"Some ack-final-indicator","required":false},"SLI-API:context-memory-json":{"type":"Some context-memory-json","required":false},"SLI-API:response-message":{"type":"Some response-message","required":false}}},"SLI-API(config)sli-parameter":{"$schema":"http://json-schema.org/draft-04/schema","id":"SLI-API(config)sli-parameter","type":"object","properties":{"SLI-API:boolean-value":{"type":"true","required":false},"SLI-API:parameter-name":{"description":"Parameter name","type":"Some parameter-name","required":false},"SLI-API:int-value":{"type":"-2147483648","required":false},"SLI-API:string-value":{"type":"Some string-value","required":false}}},"SLI-API/test-results(config)test-result":{"$schema":"http://json-schema.org/draft-04/schema","id":"SLI-API/test-results(config)test-result","type":"object","properties":{"SLI-API:results":{"type":"array","items":{"type":"Some results"},"required":false},"SLI-API:test-identifier":{"type":"Some test-identifier","required":false}}},"(config)sli-parameterPOST":{"$schema":"http://json-schema.org/draft-04/schema","id":"(config)sli-parameterPOST","type":"object","properties":{"parameter-name":{"description":"Parameter name","type":"Some parameter-name","required":false},"boolean-value":{"type":"true","required":false},"string-value":{"type":"Some string-value","required":false},"int-value":{"type":"-2147483648","required":false}}},"SLI-API(config)test-results":{"$schema":"http://json-schema.org/draft-04/schema","id":"SLI-API(config)test-results","type":"object","properties":{"SLI-API:test-result":{"type":"array","items":{"$ref":"SLI-API/test-results(config)test-result"}}}},"(healthcheck)input":{"$schema":"http://json-schema.org/draft-04/schema","id":"(healthcheck)input","type":"object","properties":{"SLI-API:dummy-leaf":{"type":"Some dummy-leaf","required":false}}},"(execute-graph)input":{"$schema":"http://json-schema.org/draft-04/schema","id":"(execute-graph)input","type":"object","properties":{"SLI-API:rpc-name":{"type":"Some rpc-name","required":false},"SLI-API:sli-parameter":{"type":"array","items":{"$ref":"SLI-API(config)sli-parameter"}},"SLI-API:module-name":{"type":"Some module-name","required":false},"SLI-API:mode":{"type":"sync","required":false,"enum":["sync","async"]}}},"(execute-graph)input-TOP":{"$schema":"http://json-schema.org/draft-04/schema","id":"(execute-graph)input-TOP","type":"object","properties":{"SLI-API:input":{"type":"object","items":{"$ref":"(execute-graph)input"}}}},"unique_empty_identifier":{},"SLI-API/test-results(config)test-result-TOP":{"$schema":"http://json-schema.org/draft-04/schema","id":"SLI-API/test-results(config)test-result-TOP","type":"object","properties":{"SLI-API:test-result":{"type":"array","items":{"$ref":"SLI-API/test-results(config)test-result"}}}},"SLI-API(config)sli-parameter-TOP":{"$schema":"http://json-schema.org/draft-04/schema","id":"SLI-API(config)sli-parameter-TOP","type":"object","properties":{"SLI-API:sli-parameter":{"type":"array","items":{"$ref":"SLI-API(config)sli-parameter"}}}},"SLI-API(operational)test-results":{"$schema":"http://json-schema.org/draft-04/schema","id":"SLI-API(operational)test-results","type":"object","properties":{}},"(execute-graph)output-TOP":{"$schema":"http://json-schema.org/draft-04/schema","id":"(execute-graph)output-TOP","type":"object","properties":{"SLI-API:output":{"type":"object","items":{"$ref":"(execute-graph)output"}}}},"(healthcheck)output":{"$schema":"http://json-schema.org/draft-04/schema","id":"(healthcheck)output","type":"object","properties":{"SLI-API:response-code":{"type":"Some response-code","required":false},"SLI-API:ack-final-indicator":{"type":"Some ack-final-indicator","required":false},"SLI-API:context-memory-json":{"type":"Some context-memory-json","required":false},"SLI-API:response-message":{"type":"Some response-message","required":false}}},"(config)SLI-API_modulePOST":{"$schema":"http://json-schema.org/draft-04/schema","id":"(config)SLI-API_modulePOST","type":"object","properties":{"test-results":{"type":"object","items":{"$ref":"SLI-API(config)test-results"}}}},"(config)test-resultsPOST":{"$schema":"http://json-schema.org/draft-04/schema","id":"(config)test-resultsPOST","type":"object","properties":{"test-result":{"type":"array","items":{"$ref":"SLI-API/test-results(config)test-result"}}}},"SLI-API(operational)test-results-TOP":{"$schema":"http://json-schema.org/draft-04/schema","id":"SLI-API(operational)test-results-TOP","type":"object","properties":{"SLI-API:test-results":{"description":"Test results","type":"object","items":{"$ref":"SLI-API(operational)test-results"}}}},"SLI-API(config)test-results-TOP":{"$schema":"http://json-schema.org/draft-04/schema","id":"SLI-API(config)test-results-TOP","type":"object","properties":{"SLI-API:test-results":{"description":"Test results","type":"object","items":{"$ref":"SLI-API(config)test-results"}}}},"(healthcheck)input-TOP":{"$schema":"http://json-schema.org/draft-04/schema","id":"(healthcheck)input-TOP","type":"object","properties":{"SLI-API:input":{"type":"object","items":{"$ref":"(healthcheck)input"}}}},"(healthcheck)output-TOP":{"$schema":"http://json-schema.org/draft-04/schema","id":"(healthcheck)output-TOP","type":"object","properties":{"SLI-API:output":{"type":"object","items":{"$ref":"(healthcheck)output"}}}},"(config)test-resultPOST":{"$schema":"http://json-schema.org/draft-04/schema","id":"(config)test-resultPOST","type":"object","properties":{"test-identifier":{"type":"Some test-identifier","required":false}}}}}
\ No newline at end of file
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0"
+  },
+  "basePath": "/restconf",
+  "paths": {
+    "/config": {
+      "post": {
+        "consumes": [
+          "application/json",
+          "application/xml"
+        ],
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "**(config)test-results",
+            "required": false,
+            "schema": {
+              "$ref": "#/definitions/SLI-API(config)test-results-TOP"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(config)SLI-API_modulePOST"
+            }
+          }
+        },
+        "description": "Defines API to service logic interpreter",
+        "operationId": "POST-SLI-API_module"
+      }
+    },
+    "/config/SLI-API:test-results": {
+      "delete": {
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified"
+          }
+        },
+        "description": "Test results",
+        "operationId": "DELETE-test-results"
+      },
+      "get": {
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(config)test-results"
+            }
+          }
+        },
+        "description": "Test results",
+        "operationId": "GET-test-results"
+      },
+      "post": {
+        "consumes": [
+          "application/json",
+          "application/xml"
+        ],
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "**(config)test-result",
+            "required": false,
+            "schema": {
+              "$ref": "#/definitions/SLI-API/test-results(config)test-result-TOP"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(config)test-resultsPOST"
+            }
+          }
+        },
+        "description": "Test results",
+        "operationId": "POST-test-results"
+      },
+      "put": {
+        "consumes": [
+          "application/json",
+          "application/xml"
+        ],
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "(config)test-results",
+            "required": false,
+            "schema": {
+              "$ref": "#/definitions/SLI-API(config)test-results-TOP"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/SLI-API(config)test-results-TOP"
+            }
+          }
+        },
+        "description": "Test results",
+        "operationId": "PUT-test-results"
+      }
+    },
+    "/config/SLI-API:test-results/test-result/{test-identifier}": {
+      "delete": {
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "test-identifier",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified"
+          }
+        },
+        "operationId": "DELETE-test-result"
+      },
+      "get": {
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "test-identifier",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(config)test-result"
+            }
+          }
+        },
+        "operationId": "GET-test-result"
+      },
+      "put": {
+        "consumes": [
+          "application/json",
+          "application/xml"
+        ],
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "test-identifier",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "in": "body",
+            "name": "(config)test-result",
+            "required": false,
+            "schema": {
+              "$ref": "#/definitions/SLI-API/test-results(config)test-result-TOP"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/SLI-API/test-results(config)test-result-TOP"
+            }
+          }
+        },
+        "operationId": "PUT-test-result"
+      }
+    },
+    "/operational/SLI-API:test-results": {
+      "get": {
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(operational)test-results"
+            }
+          }
+        },
+        "description": "Test results",
+        "operationId": "GET-test-results"
+      }
+    },
+    "/operations/SLI-API:execute-graph": {
+      "post": {
+        "consumes": [
+          "application/json",
+          "application/xml"
+        ],
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "body",
+            "required": false,
+            "schema": {
+              "$ref": "#/definitions/(execute-graph)input-TOP"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(execute-graph)output-TOP"
+            }
+          }
+        },
+        "description": " Method to add a new parameter.",
+        "operationId": "execute-graph"
+      }
+    },
+    "/operations/SLI-API:healthcheck": {
+      "post": {
+        "produces": [
+          "application/json",
+          "application/xml"
+        ],
+        "responses": {
+          "200": {
+            "description": "No response was specified",
+            "schema": {
+              "$ref": "#/definitions/(healthcheck)output-TOP"
+            }
+          }
+        },
+        "operationId": "healthcheck"
+      }
+    }
+  },
+  "definitions": {
+    "(config)SLI-API_modulePOST": {
+      "properties": {
+        "test-results": {
+          "items": {
+            "$ref": "#/definitions/SLI-API(config)test-results"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "(config)sli-parameterPOST": {
+      "properties": {
+        "boolean-value": {
+          "$ref": "#/definitions/true"
+        },
+        "int-value": {
+          "$ref": "#/definitions/-2147483648"
+        },
+        "parameter-name": {
+          "$ref": "#/definitions/Some parameter-name",
+          "description": "Parameter name"
+        },
+        "string-value": {
+          "$ref": "#/definitions/Some string-value"
+        }
+      },
+      "type": "object"
+    },
+    "(config)test-resultPOST": {
+      "properties": {
+        "test-identifier": {
+          "$ref": "#/definitions/Some test-identifier"
+        }
+      },
+      "type": "object"
+    },
+    "(config)test-resultsPOST": {
+      "properties": {
+        "test-result": {
+          "items": {
+            "$ref": "#/definitions/SLI-API/test-results(config)test-result"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "(execute-graph)input": {
+      "properties": {
+        "SLI-API:mode": {
+          "$ref": "#/definitions/sync",
+          "enum": [
+            "sync",
+            "async"
+          ]
+        },
+        "SLI-API:module-name": {
+          "$ref": "#/definitions/Some module-name"
+        },
+        "SLI-API:rpc-name": {
+          "$ref": "#/definitions/Some rpc-name"
+        },
+        "SLI-API:sli-parameter": {
+          "items": {
+            "$ref": "#/definitions/SLI-API(config)sli-parameter"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "(execute-graph)input-TOP": {
+      "properties": {
+        "SLI-API:input": {
+          "items": {
+            "$ref": "#/definitions/(execute-graph)input"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "(execute-graph)output": {
+      "properties": {
+        "SLI-API:ack-final-indicator": {
+          "$ref": "#/definitions/Some ack-final-indicator"
+        },
+        "SLI-API:context-memory-json": {
+          "$ref": "#/definitions/Some context-memory-json"
+        },
+        "SLI-API:response-code": {
+          "$ref": "#/definitions/Some response-code"
+        },
+        "SLI-API:response-message": {
+          "$ref": "#/definitions/Some response-message"
+        }
+      },
+      "type": "object"
+    },
+    "(execute-graph)output-TOP": {
+      "properties": {
+        "SLI-API:output": {
+          "items": {
+            "$ref": "#/definitions/(execute-graph)output"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "(healthcheck)output": {
+      "properties": {
+        "SLI-API:ack-final-indicator": {
+          "$ref": "#/definitions/Some ack-final-indicator"
+        },
+        "SLI-API:context-memory-json": {
+          "$ref": "#/definitions/Some context-memory-json"
+        },
+        "SLI-API:response-code": {
+          "$ref": "#/definitions/Some response-code"
+        },
+        "SLI-API:response-message": {
+          "$ref": "#/definitions/Some response-message"
+        }
+      },
+      "type": "object"
+    },
+    "(healthcheck)output-TOP": {
+      "properties": {
+        "SLI-API:output": {
+          "items": {
+            "$ref": "#/definitions/(healthcheck)output"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "SLI-API(config)sli-parameter": {
+      "properties": {
+        "SLI-API:boolean-value": {
+          "$ref": "#/definitions/true"
+        },
+        "SLI-API:int-value": {
+          "$ref": "#/definitions/-2147483648"
+        },
+        "SLI-API:parameter-name": {
+          "$ref": "#/definitions/Some parameter-name",
+          "description": "Parameter name"
+        },
+        "SLI-API:string-value": {
+          "$ref": "#/definitions/Some string-value"
+        }
+      },
+      "type": "object"
+    },
+    "SLI-API(config)sli-parameter-TOP": {
+      "properties": {
+        "SLI-API:sli-parameter": {
+          "items": {
+            "$ref": "#/definitions/SLI-API(config)sli-parameter"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "SLI-API(config)test-results": {
+      "properties": {
+        "SLI-API:test-result": {
+          "items": {
+            "$ref": "#/definitions/SLI-API/test-results(config)test-result"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "SLI-API(config)test-results-TOP": {
+      "properties": {
+        "SLI-API:test-results": {
+          "description": "Test results",
+          "items": {
+            "$ref": "#/definitions/SLI-API(config)test-results"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "SLI-API(operational)test-results": {
+      "type": "object"
+    },
+    "SLI-API(operational)test-results-TOP": {
+      "properties": {
+        "SLI-API:test-results": {
+          "description": "Test results",
+          "items": {
+            "$ref": "#/definitions/SLI-API(operational)test-results"
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "SLI-API/test-results(config)test-result": {
+      "properties": {
+        "SLI-API:results": {
+          "items": {
+            "$ref": "#/definitions/Some results"
+          },
+          "type": "array"
+        },
+        "SLI-API:test-identifier": {
+          "$ref": "#/definitions/Some test-identifier"
+        }
+      },
+      "type": "object"
+    },
+    "SLI-API/test-results(config)test-result-TOP": {
+      "properties": {
+        "SLI-API:test-result": {
+          "items": {
+            "$ref": "#/definitions/SLI-API/test-results(config)test-result"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "unique_empty_identifier": {}
+  }
+}