mirror of
https://github.com/containers/podman.git
synced 2025-09-10 12:32:21 +08:00
2a411bcbfa
As I've mentioned once or twice, hand-maintained swagger docs
are evil. This commit attempts to fix:
* Inconsistent methods (swagger says POST but code signature
says GET)
* Inconsistent capitalization
* Typos ("Mounter", "pood")
* Completely wrong paths (/inspect vs /json)
* Missing .Method() registrations
* Missing /libpod in some /volumes paths
* Incorrect method declaration: /libpod/containers/.../kill
was correct (POST) in swagger but wrong in the code itself
(http.MethodGet). Correct the latter to MethodPost
This is two hours' work, even with a script I have that
tries to cross-check everything.
Swagger docs should not be human-maintained.
Signed-off-by: Ed Santiago <santiago@redhat.com>
80 lines
2.2 KiB
Go
80 lines
2.2 KiB
Go
package server
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/containers/libpod/pkg/api/handlers/libpod"
|
|
"github.com/gorilla/mux"
|
|
)
|
|
|
|
func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
|
|
// swagger:operation POST /libpod/volumes/create volumes createVolume
|
|
// ---
|
|
// summary: Create a volume
|
|
// produces:
|
|
// - application/json
|
|
// responses:
|
|
// '200':
|
|
// description: tbd
|
|
// '500':
|
|
// "$ref": "#/responses/InternalError"
|
|
r.Handle("/libpod/volumes/create", s.APIHandler(libpod.CreateVolume)).Methods(http.MethodPost)
|
|
r.Handle("/libpod/volumes/json", s.APIHandler(libpod.ListVolumes)).Methods(http.MethodGet)
|
|
// swagger:operation POST /libpod/volumes/prune volumes pruneVolumes
|
|
// ---
|
|
// summary: Prune volumes
|
|
// produces:
|
|
// - application/json
|
|
// responses:
|
|
// '204':
|
|
// description: no error
|
|
// '500':
|
|
// "$ref": "#/responses/InternalError"
|
|
r.Handle("/libpod/volumes/prune", s.APIHandler(libpod.PruneVolumes)).Methods(http.MethodPost)
|
|
// swagger:operation GET /libpod/volumes/{name}/json volumes inspectVolume
|
|
// ---
|
|
// summary: Inspect volume
|
|
// parameters:
|
|
// - in: path
|
|
// name: name
|
|
// type: string
|
|
// required: true
|
|
// description: the name or ID of the volume
|
|
// produces:
|
|
// - application/json
|
|
// responses:
|
|
// '200':
|
|
// "$ref": "#/responses/InspectVolumeResponse"
|
|
// '404':
|
|
// "$ref": "#/responses/NoSuchVolume"
|
|
// '500':
|
|
// "$ref": "#/responses/InternalError"
|
|
r.Handle("/libpod/volumes/{name}/json", s.APIHandler(libpod.InspectVolume)).Methods(http.MethodGet)
|
|
// swagger:operation DELETE /libpod/volumes/{name} volumes removeVolume
|
|
// ---
|
|
// summary: Remove volume
|
|
// parameters:
|
|
// - in: path
|
|
// name: name
|
|
// type: string
|
|
// required: true
|
|
// description: the name or ID of the volume
|
|
// - in: query
|
|
// name: force
|
|
// type: boolean
|
|
// description: force removal
|
|
// produces:
|
|
// - application/json
|
|
// responses:
|
|
// 204:
|
|
// description: no error
|
|
// 400:
|
|
// $ref: "#/responses/BadParamError"
|
|
// 404:
|
|
// $ref: "#/responses/NoSuchVolume"
|
|
// 500:
|
|
// $ref: "#/responses/InternalError"
|
|
r.Handle("/libpod/volumes/{name}", s.APIHandler(libpod.RemoveVolume)).Methods(http.MethodDelete)
|
|
return nil
|
|
}
|