aboutsummaryrefslogtreecommitdiffstats
path: root/docs/pap/swagger/health-check-pap.json
diff options
context:
space:
mode:
authorJim Hahn <jrh3@att.com>2019-05-29 15:41:48 -0400
committerJim Hahn <jrh3@att.com>2019-05-30 09:08:43 -0400
commitd5cc948b2c25b5e444705ba133b3d619474e1bc6 (patch)
tree57c245c0873fb84f684cb9022ce1ab4071e745a1 /docs/pap/swagger/health-check-pap.json
parentd8d3191510be75033894d41439dc92ba250eeda5 (diff)
Add documentation for PAP
Included updates per Ram. Change-Id: Ib09c9b7e39aab566ebd3eae813fde6bc3e2fabd7 Issue-ID: POLICY-1681 Signed-off-by: Jim Hahn <jrh3@att.com>
Diffstat (limited to 'docs/pap/swagger/health-check-pap.json')
-rw-r--r--docs/pap/swagger/health-check-pap.json71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/pap/swagger/health-check-pap.json b/docs/pap/swagger/health-check-pap.json
new file mode 100644
index 00000000..3bf87e22
--- /dev/null
+++ b/docs/pap/swagger/health-check-pap.json
@@ -0,0 +1,71 @@
+{
+ "swagger" : "2.0",
+ "basePath" : "/",
+ "tags" : [ {
+ "name" : "HealthCheck"
+ } ],
+ "schemes" : [ "http", "https" ],
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "paths" : {
+ "/policy/pap/v1/healthcheck" : {
+ "get" : {
+ "tags" : [ "HealthCheck" ],
+ "summary" : "Perform healthcheck",
+ "description" : "Returns healthy status of the Policy Administration component",
+ "operationId" : "healthcheck",
+ "produces" : [ "application/json" ],
+ "parameters" : [ ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/HealthCheckReport"
+ }
+ },
+ "401" : {
+ "description" : "Authentication Error"
+ },
+ "403" : {
+ "description" : "Authorization Error"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ },
+ "security" : [ {
+ "basicAuth" : [ ]
+ } ]
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+}