Release note

Change-Id: Ie4d80255b3a743a15910ac309fefd7e86c203b2b
Issue-ID: HOLMES-136
Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>

diff --git a/api/readme.txt b/api/readme.txt
new file mode 100644 (file)
index 0000000..7d8366d
--- /dev/null
+++ b/api/readme.txt
@@ -0,0 +1,4 @@
+Replace the original swagger.json with the new one.
+
+Repo: holmes/engine-management
+Path: engine-d/src/main/resources

diff --git a/api/swagger.json b/api/swagger.json
new file mode 100644 (file)
index 0000000..511ce72
--- /dev/null
+++ b/api/swagger.json
@@ -0,0 +1,131 @@
+{
+  "swagger" : "2.0",
+  "info" : {
+    "description" : "This page shows all the APIs available in the Holmes engine management module.",
+    "version" : "v1",
+    "title" : "API Descriptions for Holmes Engine Management",
+    "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin",
+    "contact" : {
+      "name" : "Guangrong Fu",
+      "email" : "fu.guangrong@zte.com.cn"
+    },
+    "license" : {
+      "name" : "Apache 2.0",
+      "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
+    }
+  },
+  "basePath" : "/api/holmes-engine-mgmt/v1/",
+  "tags" : [ {
+    "name" : "Health Check"
+  }, {
+    "name" : "Holmes Engine Management"
+  } ],
+  "paths" : {
+    "/healthcheck" : {
+      "get" : {
+        "tags" : [ "Health Check" ],
+        "summary" : "Interface for the health check of the engine management module for Holmes",
+        "description" : "",
+        "operationId" : "healthCheck",
+        "produces" : [ "text/plain" ],
+        "responses" : {
+          "200" : {
+            "description" : "successful operation",
+            "schema" : {
+              "type" : "boolean"
+            }
+          }
+        }
+      }
+    },
+    "/rule" : {
+      "post" : {
+        "tags" : [ "Holmes Engine Management" ],
+        "summary" : "Check the validity of a rule.",
+        "description" : "",
+        "operationId" : "compileRule",
+        "produces" : [ "application/json" ],
+        "responses" : {
+          "200" : {
+            "description" : "successful operation",
+            "schema" : {
+              "type" : "boolean"
+            }
+          }
+        }
+      },
+      "put" : {
+        "tags" : [ "Holmes Engine Management" ],
+        "summary" : "Deploy a rule into the Drools engine.",
+        "description" : "",
+        "operationId" : "deployRule",
+        "produces" : [ "application/json" ],
+        "parameters" : [ {
+          "in" : "body",
+          "name" : "body",
+          "description" : "The request entity of the HTTP call, which comprises three fields: \"content\" , \"loopControlName\" and \"engineId\". The \"content\" should be a valid Drools rule string and the \"engineId\" has to be \"engine-d\" in the Beijing release.",
+          "required" : true,
+          "schema" : {
+            "$ref" : "#/definitions/DeployRuleRequest"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "successful operation",
+            "schema" : {
+              "$ref" : "#/definitions/CorrelationRuleResponse"
+            }
+          }
+        }
+      }
+    },
+    "/rule/{packageName}" : {
+      "delete" : {
+        "tags" : [ "Holmes Engine Management" ],
+        "summary" : "Undeploy a rule from the Drools engine.",
+        "description" : "",
+        "operationId" : "undeployRule",
+        "produces" : [ "application/json" ],
+        "parameters" : [ {
+          "name" : "packageName",
+          "in" : "path",
+          "required" : true,
+          "type" : "string"
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "successful operation",
+            "schema" : {
+              "type" : "boolean"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions" : {
+    "CorrelationRuleResponse" : {
+      "type" : "object",
+      "properties" : {
+        "package" : {
+          "type" : "string"
+        }
+      }
+    },
+    "DeployRuleRequest" : {
+      "type" : "object",
+      "required" : [ "content", "loopControlName" ],
+      "properties" : {
+        "content" : {
+          "type" : "string"
+        },
+        "engineId" : {
+          "type" : "string"
+        },
+        "loopControlName" : {
+          "type" : "string"
+        }
+      }
+    }
+  }
+}
\ No newline at end of file

diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index 04520fd..a7ef13a 100644 (file)
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -1,6 +1,6 @@
 Holmes Engine Management Component Offered APIs
 ==================================
-The rule management module provides the following APIs.
+The engine management module provides the following APIs.
 
 * Rule Deployment
 * Rule Undeployment