From 2099643aa2929e8d394c8b0fb584ad90075ad0b5 Mon Sep 17 00:00:00 2001
From: Brent Baude <bbaude@redhat.com>
Date: Tue, 25 Feb 2020 13:51:49 -0600
Subject: add apiv2 healthcheck code

reworking binding and endpoint to actually work.  added documentation in swagger for and various return code possibilities.  add a good start on tests though we need some other container functions not yet implemented for that.

Signed-off-by: Brent Baude <bbaude@redhat.com>
---
 pkg/api/server/register_healthcheck.go | 25 ++++++++++++++++++++++++-
 pkg/api/server/swagger.go              |  9 +++++++++
 2 files changed, 33 insertions(+), 1 deletion(-)

(limited to 'pkg/api/server')

diff --git a/pkg/api/server/register_healthcheck.go b/pkg/api/server/register_healthcheck.go
index 5466e2905..69aa5bbfb 100644
--- a/pkg/api/server/register_healthcheck.go
+++ b/pkg/api/server/register_healthcheck.go
@@ -8,6 +8,29 @@ import (
 )
 
 func (s *APIServer) registerHealthCheckHandlers(r *mux.Router) error {
-	r.Handle(VersionedPath("/libpod/containers/{name}/runhealthcheck"), s.APIHandler(libpod.RunHealthCheck)).Methods(http.MethodGet)
+	// swagger:operation GET /libpod/containers/{name:.*}/healthcheck libpod libpodRunHealthCheck
+	// ---
+	// tags:
+	//  - containers
+	// summary: Run a container's healthcheck
+	// description: Execute the defined healthcheck and return information about the results
+	// parameters:
+	//  - in: path
+	//    name: name:.*
+	//    type: string
+	//    required: true
+	//    description: the name or ID of the container
+	// produces:
+	// - application/json
+	// responses:
+	//   200:
+	//     $ref: "#/responses/HealthcheckRun"
+	//   404:
+	//     $ref: "#/responses/NoSuchContainer"
+	//   409:
+	//     description: container has no healthcheck or is not running
+	//   500:
+	//     $ref: '#/responses/InternalError'
+	r.Handle(VersionedPath("/libpod/containers/{name:.*}/healthcheck"), s.APIHandler(libpod.RunHealthCheck)).Methods(http.MethodGet)
 	return nil
 }
diff --git a/pkg/api/server/swagger.go b/pkg/api/server/swagger.go
index 011196e5a..e3c991d6d 100644
--- a/pkg/api/server/swagger.go
+++ b/pkg/api/server/swagger.go
@@ -156,3 +156,12 @@ type swagVolumeListResponse struct {
 	// in:body
 	Body []libpod.Volume
 }
+
+// Healthcheck
+// swagger:response HealthcheckRun
+type swagHealthCheckRunResponse struct {
+	// in:body
+	Body struct {
+		libpod.HealthCheckResults
+	}
+}
-- 
cgit v1.2.3-54-g00ecf