diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2021-04-06 13:31:56 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-06 13:31:56 -0400 |
| commit | a0873b6650974ee660584388d1e5bd453e3b9d92 (patch) | |
| tree | 1d6fbbaa7e52066773a9522918b75d30257d8d5f | |
| parent | 453aab39416ba25b5d57c68ce1baa8035e4c9ff8 (diff) | |
| parent | 51b23be38b1018f5cee06e75dc481b5e070d6b41 (diff) | |
| download | podman-a0873b6650974ee660584388d1e5bd453e3b9d92.tar.gz podman-a0873b6650974ee660584388d1e5bd453e3b9d92.tar.bz2 podman-a0873b6650974ee660584388d1e5bd453e3b9d92.zip | |
Merge pull request #9953 from jwhonce/wip/operation_id
[CI:DOCS] Polish swagger OperationIDs
| -rwxr-xr-x | hack/swagger-check | 5 | ||||
| -rw-r--r-- | pkg/api/server/register_containers.go | 6 | ||||
| -rw-r--r-- | pkg/api/server/register_play.go | 2 | ||||
| -rw-r--r-- | pkg/api/server/register_pods.go | 2 |
4 files changed, 5 insertions, 10 deletions
diff --git a/hack/swagger-check b/hack/swagger-check index d20318305..f2e30cc33 100755 --- a/hack/swagger-check +++ b/hack/swagger-check @@ -252,11 +252,6 @@ sub handle_handle { $tag = 'system'; } - # Special case: /changes is libpod even though it says compat - if ($endpoint =~ m!/changes!) { - $tag = 'libpod'; - } - state $previous_path; # Previous path name, to avoid dups # diff --git a/pkg/api/server/register_containers.go b/pkg/api/server/register_containers.go index 3bf3e4e11..c2bb44c8f 100644 --- a/pkg/api/server/register_containers.go +++ b/pkg/api/server/register_containers.go @@ -774,7 +774,7 @@ func (s *APIServer) registerContainersHandlers(r *mux.Router) error { // 500: // $ref: "#/responses/InternalError" r.HandleFunc(VersionedPath("/libpod/containers/prune"), s.APIHandler(compat.PruneContainers)).Methods(http.MethodPost) - // swagger:operation GET /libpod/containers/showmounted libpod ShowMountedContainersLibpod + // swagger:operation GET /libpod/containers/showmounted libpod ContainerShowMountedLibpod // --- // tags: // - containers @@ -1468,8 +1468,8 @@ func (s *APIServer) registerContainersHandlers(r *mux.Router) error { // 500: // $ref: "#/responses/InternalError" r.HandleFunc(VersionedPath("/libpod/containers/{name}/restore"), s.APIHandler(libpod.Restore)).Methods(http.MethodPost) - // swagger:operation GET /containers/{name}/changes libpod ContainerChangesLibpod - // swagger:operation GET /libpod/containers/{name}/changes compat ContainerChanges + // swagger:operation GET /containers/{name}/changes compat ContainerChanges + // swagger:operation GET /libpod/containers/{name}/changes libpod ContainerChangesLibpod // --- // tags: // - containers diff --git a/pkg/api/server/register_play.go b/pkg/api/server/register_play.go index b9d3349be..d21029db5 100644 --- a/pkg/api/server/register_play.go +++ b/pkg/api/server/register_play.go @@ -8,7 +8,7 @@ import ( ) func (s *APIServer) registerPlayHandlers(r *mux.Router) error { - // swagger:operation POST /libpod/play/kube libpod KubePlayLibpod + // swagger:operation POST /libpod/play/kube libpod PlayKubeLibpod // --- // tags: // - containers diff --git a/pkg/api/server/register_pods.go b/pkg/api/server/register_pods.go index 226cbce11..5944b98fd 100644 --- a/pkg/api/server/register_pods.go +++ b/pkg/api/server/register_pods.go @@ -305,7 +305,7 @@ func (s *APIServer) registerPodsHandlers(r *mux.Router) error { // 500: // $ref: "#/responses/InternalError" r.Handle(VersionedPath("/libpod/pods/{name}/top"), s.APIHandler(libpod.PodTop)).Methods(http.MethodGet) - // swagger:operation GET /libpod/pods/stats pods PodStatsLibpod + // swagger:operation GET /libpod/pods/stats pods PodStatsAllLibpod // --- // tags: // - pods |