summaryrefslogtreecommitdiff
path: root/pkg/api/server/register_healthcheck.go
diff options
context:
space:
mode:
authorBrent Baude <bbaude@redhat.com>2020-02-25 13:51:49 -0600
committerBrent Baude <bbaude@redhat.com>2020-03-13 07:43:12 -0500
commit2099643aa2929e8d394c8b0fb584ad90075ad0b5 (patch)
treea40d66583f16581bcfd0ed2094acf478d151e442 /pkg/api/server/register_healthcheck.go
parentc9f148fb154ca45081e3ebfc0c14fa9ee995780d (diff)
downloadpodman-2099643aa2929e8d394c8b0fb584ad90075ad0b5.tar.gz
podman-2099643aa2929e8d394c8b0fb584ad90075ad0b5.tar.bz2
podman-2099643aa2929e8d394c8b0fb584ad90075ad0b5.zip
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>
Diffstat (limited to 'pkg/api/server/register_healthcheck.go')
-rw-r--r--pkg/api/server/register_healthcheck.go25
1 files changed, 24 insertions, 1 deletions
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
}