| Chenfei Gao | 55e1f55 | 2019-05-21 13:32:30 -0400 | [diff] [blame^] | 1 | { |
| 2 | "swagger" : "2.0", |
| 3 | "basePath" : "/", |
| 4 | "tags" : [{ |
| 5 | "name" : "HealthCheck" |
| 6 | }], |
| 7 | "schemes" : [ "http", "https" ], |
| 8 | "paths" : { |
| 9 | "/policy/api/v1/healthcheck" : { |
| 10 | "get" : { |
| 11 | "tags" : [ "HealthCheck" ], |
| 12 | "summary" : "Perform a system healthcheck", |
| 13 | "description" : "Returns healthy status of the Policy API component", |
| 14 | "operationId" : "getHealthCheck", |
| 15 | "produces" : [ "application/json" ], |
| 16 | "parameters" : [{ |
| 17 | "name" : "X-ONAP-RequestID", |
| 18 | "in" : "header", |
| 19 | "description" : "RequestID for http transaction", |
| 20 | "required" : false, |
| 21 | "type" : "string", |
| 22 | "format" : "uuid" |
| 23 | } ], |
| 24 | "responses" : { |
| 25 | "200" : { |
| 26 | "description" : "successful operation; Healthcheck report will be returned.", |
| 27 | "headers" : { |
| 28 | "X-MinorVersion" : { |
| 29 | "type" : "string", |
| 30 | "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client" |
| 31 | }, |
| 32 | "X-PatchVersion" : { |
| 33 | "type" : "string", |
| 34 | "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" |
| 35 | }, |
| 36 | "X-LatestVersion" : { |
| 37 | "type" : "string", |
| 38 | "description" : "Used only to communicate an API's latest version" |
| 39 | }, |
| 40 | "X-ONAP-RequestID" : { |
| 41 | "type" : "string", |
| 42 | "format" : "uuid", |
| 43 | "description" : "Used to track REST transactions for logging purpose" |
| 44 | } |
| 45 | }, |
| 46 | "schema" : { |
| 47 | "$ref" : "#/definitions/HealthCheckReport" |
| 48 | } |
| 49 | }, |
| 50 | "401" : { |
| 51 | "description" : "Authentication Error" |
| 52 | }, |
| 53 | "403" : { |
| 54 | "description" : "Authorization Error" |
| 55 | }, |
| 56 | "500" : { |
| 57 | "description" : "Internal Server Error" |
| 58 | } |
| 59 | }, |
| 60 | "security" : [ { |
| 61 | "basicAuth" : [ ] |
| 62 | } ], |
| 63 | "x-interface info" : { |
| 64 | "api-version" : "1.0.0", |
| 65 | "last-mod-release" : "Dublin" |
| 66 | } |
| 67 | } |
| 68 | } |
| 69 | }, |
| 70 | "securityDefinitions" : { |
| 71 | "basicAuth" : { |
| 72 | "description" : "", |
| 73 | "type" : "basic" |
| 74 | } |
| 75 | }, |
| 76 | "definitions" : { |
| 77 | "HealthCheckReport" : { |
| 78 | "type" : "object", |
| 79 | "properties" : { |
| 80 | "name" : { |
| 81 | "type" : "string" |
| 82 | }, |
| 83 | "url" : { |
| 84 | "type" : "string" |
| 85 | }, |
| 86 | "healthy" : { |
| 87 | "type" : "boolean" |
| 88 | }, |
| 89 | "code" : { |
| 90 | "type" : "integer", |
| 91 | "format" : "int32" |
| 92 | }, |
| 93 | "message" : { |
| 94 | "type" : "string" |
| 95 | } |
| 96 | } |
| 97 | } |
| 98 | } |
| 99 | } |