blob: 3bf87e222b60c3b4c7a44c7289f7b91562b9b1a8 [file] [log] [blame]
Jim Hahnd5cc9482019-05-29 15:41:48 -04001{
2 "swagger" : "2.0",
3 "basePath" : "/",
4 "tags" : [ {
5 "name" : "HealthCheck"
6 } ],
7 "schemes" : [ "http", "https" ],
8 "consumes" : [ "application/json" ],
9 "produces" : [ "application/json" ],
10 "paths" : {
11 "/policy/pap/v1/healthcheck" : {
12 "get" : {
13 "tags" : [ "HealthCheck" ],
14 "summary" : "Perform healthcheck",
15 "description" : "Returns healthy status of the Policy Administration component",
16 "operationId" : "healthcheck",
17 "produces" : [ "application/json" ],
18 "parameters" : [ ],
19 "responses" : {
20 "200" : {
21 "description" : "successful operation",
22 "schema" : {
23 "$ref" : "#/definitions/HealthCheckReport"
24 }
25 },
26 "401" : {
27 "description" : "Authentication Error"
28 },
29 "403" : {
30 "description" : "Authorization Error"
31 },
32 "500" : {
33 "description" : "Internal Server Error"
34 }
35 },
36 "security" : [ {
37 "basicAuth" : [ ]
38 } ]
39 }
40 }
41 },
42 "securityDefinitions" : {
43 "basicAuth" : {
44 "description" : "",
45 "type" : "basic"
46 }
47 },
48 "definitions" : {
49 "HealthCheckReport" : {
50 "type" : "object",
51 "properties" : {
52 "name" : {
53 "type" : "string"
54 },
55 "url" : {
56 "type" : "string"
57 },
58 "healthy" : {
59 "type" : "boolean"
60 },
61 "code" : {
62 "type" : "integer",
63 "format" : "int32"
64 },
65 "message" : {
66 "type" : "string"
67 }
68 }
69 }
70 }
71}