Add policy design api documentation

Adding swagger and global api table to api rst documentation

Issue-ID: POLICY-1680
Change-Id: Iae966917b73a8762172e708fe207c4fc6e52615f
Signed-off-by: Chenfei Gao <cgao@research.att.com>

1 files changed, 99 insertions, 0 deletions

diff --git a/docs/api/healthcheck-api.json b/docs/api/healthcheck-api.json
new file mode 100644
index 00000000..6605ee57
--- /dev/null
+++ b/docs/api/healthcheck-api.json
@@ -0,0 +1,99 @@
+{
+  "swagger" : "2.0",
+  "basePath" : "/",
+  "tags" : [{
+    "name" : "HealthCheck"
+  }],
+  "schemes" : [ "http", "https" ],
+  "paths" : {
+    "/policy/api/v1/healthcheck" : {
+      "get" : {
+        "tags" : [ "HealthCheck" ],
+        "summary" : "Perform a system healthcheck",
+        "description" : "Returns healthy status of the Policy API component",
+        "operationId" : "getHealthCheck",
+        "produces" : [ "application/json" ],
+        "parameters" : [{
+          "name" : "X-ONAP-RequestID",
+          "in" : "header",
+          "description" : "RequestID for http transaction",
+          "required" : false,
+          "type" : "string",
+          "format" : "uuid"
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "successful operation; Healthcheck report will be returned.",
+            "headers" : {
+              "X-MinorVersion" : {
+                "type" : "string",
+                "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
+              },
+              "X-PatchVersion" : {
+                "type" : "string",
+                "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
+              },
+              "X-LatestVersion" : {
+                "type" : "string",
+                "description" : "Used only to communicate an API's latest version"
+              },
+              "X-ONAP-RequestID" : {
+                "type" : "string",
+                "format" : "uuid",
+                "description" : "Used to track REST transactions for logging purpose"
+              }
+            },
+            "schema" : {
+              "$ref" : "#/definitions/HealthCheckReport"
+            }
+          },
+          "401" : {
+            "description" : "Authentication Error"
+          },
+          "403" : {
+            "description" : "Authorization Error"
+          },
+          "500" : {
+            "description" : "Internal Server Error"
+          }
+        },
+        "security" : [ {
+          "basicAuth" : [ ]
+        } ],
+        "x-interface info" : {
+          "api-version" : "1.0.0",
+          "last-mod-release" : "Dublin"
+        }
+      }
+    }
+  },
+  "securityDefinitions" : {
+    "basicAuth" : {
+      "description" : "",
+      "type" : "basic"
+    }
+  },
+  "definitions" : {
+    "HealthCheckReport" : {
+      "type" : "object",
+      "properties" : {
+        "name" : {
+          "type" : "string"
+        },
+        "url" : {
+          "type" : "string"
+        },
+        "healthy" : {
+          "type" : "boolean"
+        },
+        "code" : {
+          "type" : "integer",
+          "format" : "int32"
+        },
+        "message" : {
+          "type" : "string"
+        }
+      }
+    }
+  }
+}