Files
podman/pkg/api/server/register_ping.go
Jhon Honce 31112e4b08 Refactor handler packages
To help with packaging, the handlers in pkg/api/handlers are now found
in pkg/api/handler/compat.

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2020-03-10 08:03:41 -07:00

68 lines
2.3 KiB
Go

package server
import (
"net/http"
"github.com/containers/libpod/pkg/api/handlers/compat"
"github.com/gorilla/mux"
)
func (s *APIServer) registerPingHandlers(r *mux.Router) error {
r.Handle("/_ping", s.APIHandler(compat.Ping)).Methods(http.MethodGet)
r.Handle("/_ping", s.APIHandler(compat.Ping)).Methods(http.MethodHead)
// swagger:operation GET /libpod/_ping libpod libpodPingGet
// ---
// summary: Ping service
// description: |
// Return protocol information in response headers.
// `HEAD /libpod/_ping` is also supported.
// `/_ping` is available for compatibility with other engines.
// tags:
// - system (compat)
// - system
// produces:
// - text/plain
// responses:
// 200:
// description: Success
// schema:
// description: OK
// type: string
// example: "OK"
// headers:
// API-Version:
// type: string
// description: Max compatibility API Version the server supports
// BuildKit-Version:
// type: string
// description: Default version of docker image builder
// Docker-Experimental:
// type: boolean
// description: If the server is running with experimental mode enabled, always true
// Cache-Control:
// type: string
// description: always no-cache
// Pragma:
// type: string
// description: always no-cache
// Libpod-API-Version:
// type: string
// description: |
// Max Podman API Version the server supports.
// Available if service is backed by Podman, therefore may be used to
// determine if talking to Podman engine or another engine
// Libpod-Buildha-Version:
// type: string
// description: |
// Default version of libpod image builder.
// Available if service is backed by Podman, therefore may be used to
// determine if talking to Podman engine or another engine
// 500:
// $ref: "#/responses/InternalError"
r.Handle("/libpod/_ping", s.APIHandler(compat.Ping)).Methods(http.MethodGet)
r.Handle("/libpod/_ping", s.APIHandler(compat.Ping)).Methods(http.MethodHead)
return nil
}