diff options
| author | Ed Santiago <santiago@redhat.com> | 2020-02-17 07:23:55 -0700 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2020-02-18 11:07:07 -0700 |
| commit | 2a411bcbfa3dc72d3a8cb35c2d1004ab05e4e0e8 (patch) | |
| tree | 9de509509ef6012863bc10415e037aa239cec83c /pkg/api/server/register_volumes.go | |
| parent | a5d55966bde3b0798f9cb89009d443ccfac3126a (diff) | |
| download | podman-2a411bcbfa3dc72d3a8cb35c2d1004ab05e4e0e8.tar.gz podman-2a411bcbfa3dc72d3a8cb35c2d1004ab05e4e0e8.tar.bz2 podman-2a411bcbfa3dc72d3a8cb35c2d1004ab05e4e0e8.zip | |
Swagger: fix inconsistencies (try #2)
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>
Diffstat (limited to 'pkg/api/server/register_volumes.go')
| -rw-r--r-- | pkg/api/server/register_volumes.go | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/pkg/api/server/register_volumes.go b/pkg/api/server/register_volumes.go index 1ccf92b46..efe56a3ad 100644 --- a/pkg/api/server/register_volumes.go +++ b/pkg/api/server/register_volumes.go @@ -20,7 +20,7 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error { // "$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 /volumes/prune volumes pruneVolumes + // swagger:operation POST /libpod/volumes/prune volumes pruneVolumes // --- // summary: Prune volumes // produces: @@ -31,7 +31,7 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error { // '500': // "$ref": "#/responses/InternalError" r.Handle("/libpod/volumes/prune", s.APIHandler(libpod.PruneVolumes)).Methods(http.MethodPost) - // swagger:operation GET /volumes/{name}/json volumes inspectVolume + // swagger:operation GET /libpod/volumes/{name}/json volumes inspectVolume // --- // summary: Inspect volume // parameters: @@ -50,7 +50,7 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error { // '500': // "$ref": "#/responses/InternalError" r.Handle("/libpod/volumes/{name}/json", s.APIHandler(libpod.InspectVolume)).Methods(http.MethodGet) - // swagger:operation DELETE /volumes/{name} volumes removeVolume + // swagger:operation DELETE /libpod/volumes/{name} volumes removeVolume // --- // summary: Remove volume // parameters: |