github
/
portainer
mirror of https://github.com/portainer/portainer
1
0
Fork 0
Code Issues Releases Wiki Activity

added swagger docs to websocketShellPodExec (#5840)

pull/5857/head
zees-dev 2021-10-07 15:32:07 +13:00 committed by GitHub
parent 661931d8b0
commit dad762de9f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
api/http/handler/websocket/shell_pod.go
View File

@ -10,13 +10,21 @@ import (
"github.com/portainer/portainer/api/http/security" "github.com/portainer/portainer/api/http/security"
) )
// websocketShellPodExec handles GET requests on /websocket/pod?token=<token>&endpointId=<endpointID> // @summary Execute a websocket on kubectl shell pod
// The request will be upgraded to the websocket protocol. // @description The request will be upgraded to the websocket protocol. The request will proxy input from the client to the pod via long-lived websocket connection.
// Authentication and access is controlled via the mandatory token query parameter. // @description **Access policy**: authenticated
// The request will proxy input from the client to the pod via long-lived websocket connection. // @security jwt
// The following query parameters are mandatory: // @tags websocket
// * token: JWT token used for authentication against this environment(endpoint) // @accept json
// * endpointId: environment(endpoint) ID of the environment(endpoint) where the resource is located // @produce json
// @param endpointId query int true "environment(endpoint) ID of the environment(endpoint) where the resource is located"
// @param token query string true "JWT token used for authentication against this environment(endpoint)"
// @success 200
// @failure 400
// @failure 403
// @failure 404
// @failure 500
// @router /websocket/kubernetes-shell [get]
func (handler *Handler) websocketShellPodExec(w http.ResponseWriter, r *http.Request) *httperror.HandlerError { func (handler *Handler) websocketShellPodExec(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
endpointID, err := request.RetrieveNumericQueryParameter(r, "endpointId", false) endpointID, err := request.RetrieveNumericQueryParameter(r, "endpointId", false)
if err != nil { if err != nil {