summaryrefslogtreecommitdiffstats
path: root/docs/api/healthcheck-api.json
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/healthcheck-api.json')
-rw-r--r--docs/api/healthcheck-api.json99
1 files changed, 0 insertions, 99 deletions
diff --git a/docs/api/healthcheck-api.json b/docs/api/healthcheck-api.json
deleted file mode 100644
index 6605ee57..00000000
--- a/docs/api/healthcheck-api.json
+++ /dev/null
@@ -1,99 +0,0 @@
-{
- "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"
- }
- }
- }
- }
-}