1
0
Fork 0
mirror of https://github.com/portainer/portainer.git synced 2025-07-25 00:09:40 +02:00

fix(swagger) swagger annotations fixes and improvements EE-1205

This commit is contained in:
Hui 2021-10-12 12:12:08 +13:00 committed by GitHub
parent 6a67e8142d
commit e6d690e31e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
90 changed files with 190 additions and 123 deletions

View file

@ -18,7 +18,7 @@ import (
// @description If the nodeName query parameter is present, the request will be proxied to the underlying agent environment(endpoint).
// @description If the nodeName query parameter is not specified, the request will be upgraded to the websocket protocol and
// @description an AttachStart operation HTTP request will be created and hijacked.
// @description Authentication and access is controlled via the mandatory token query parameter.
// @description **Access policy**: authenticated
// @security jwt
// @tags websocket
// @accept json

View file

@ -26,7 +26,7 @@ type execStartOperationPayload struct {
// @description If the nodeName query parameter is present, the request will be proxied to the underlying agent environment(endpoint).
// @description If the nodeName query parameter is not specified, the request will be upgraded to the websocket protocol and
// @description an ExecStart operation HTTP request will be created and hijacked.
// @description Authentication and access is controlled via the mandatory token query parameter.
// @**Access policy**: authenticated
// @security jwt
// @tags websocket
// @accept json

View file

@ -19,7 +19,7 @@ import (
// @summary Execute a websocket on pod
// @description The request will be upgraded to the websocket protocol.
// @description Authentication and access is controlled via the mandatory token query parameter.
// @description **Access policy**: authenticated
// @security jwt
// @tags websocket
// @accept json

View file

@ -19,11 +19,10 @@ import (
// @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
// @success 200 "Success"
// @failure 400 "Invalid request"
// @failure 403 "Permission denied"
// @failure 500 "Server error"
// @router /websocket/kubernetes-shell [get]
func (handler *Handler) websocketShellPodExec(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
endpointID, err := request.RetrieveNumericQueryParameter(r, "endpointId", false)