Help us shape the future of Go! Take the 2026 Go Developer Survey

workspaces

package
v0.3.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAll

func GetAll() gin.HandlerFunc

@Summary Get workspaces @Schemes @Description Get workspaces @Tags workspaces @Accept application/json @Produce application/json @Success 200 {array} apicontracts.Workspace @Failure 403 {string} Forbidden @Failure 401 {string} Unauthorized @Failure 500 {string} Failure message @Router /v1/workspaces [get] @Security ApiKey || AccessToken

func GetById

func GetById() gin.HandlerFunc

@Summary Get a workspace by id @Schemes @Description Get a workspace its id @Tags workspaces @Accept application/json @Produce application/json @Param id path string true "id" @Success 200 {object} apicontracts.Workspace @Failure 403 {string} Forbidden @Failure 401 {string} Unauthorized @Failure 500 {string} Failure message @Router /v1/workspaces/id/{workspaceName} [get] @Security ApiKey || AccessToken

func GetByName

func GetByName() gin.HandlerFunc

@Summary Get a workspace @Schemes @Description Get a workspace its name @Tags workspaces @Accept application/json @Produce application/json @Param name path string true "name" @Success 200 {object} apicontracts.Workspace @Failure 403 {string} Forbidden @Failure 401 {string} Unauthorized @Failure 500 {string} Failure message @Router /v1/workspaces/{workspaceName} [get] @Security ApiKey || AccessToken

func GetKubeconfig

func GetKubeconfig() gin.HandlerFunc

Get a kubeconfig by workspace name. Identity must be authorized to view the requested cluster

@Summary	Get kubeconfig for workspace
@Schemes
@Description	Get a kubeconfig by workspace name.
@Tags			workspaces
@Accept			application/json
@Produce		application/json
@Param			id	path		string	true	"id"
@Param			credentials				body	apicontracts.KubeconfigCredentials	true	"Credentials"
@Success		200	{object}	apicontracts.ClusterKubeconfig
@Failure		403	{string}	Forbidden
@Failure		401	{string}	Unauthorized
@Failure		500	{string}	Failure	message
@Router			/v1/workspaces/{workspaceName}/login [post]
@Security		ApiKey || AccessToken

func Update

func Update() gin.HandlerFunc

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL