diff options
Diffstat (limited to 'docs/pap/swagger/health-check-pap.json')
-rw-r--r-- | docs/pap/swagger/health-check-pap.json | 71 |
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" + } + } + } + } +} |