1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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", "application/yaml" ],
"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"
}
}
}
}
}
|
