hertz

Documentation

Index

• func CreateNotebookServer(ctx context.Context, c *app.RequestContext, handler command.CreateHandler)
• func DeleteNotebookServer(ctx context.Context, c *app.RequestContext, handler command.DeleteHandler)
• func GetNotebookServer(ctx context.Context, c *app.RequestContext, handler query.GetHandler)
• func ListNotebookServers(ctx context.Context, c *app.RequestContext, handler query.ListHandler)
• func NewRouteRegister(service *application.Service) server.RouteRegister
• func SwitchNotebookServer(ctx context.Context, c *app.RequestContext, handler command.SwitchHandler)
• func UpdateNotebookServerSettings(ctx context.Context, c *app.RequestContext, handler command.UpdateHandler)

Functions

func CreateNotebookServer

func CreateNotebookServer(ctx context.Context, c *app.RequestContext, handler command.CreateHandler)

CreateNotebookServer create notebook server

@Summary		use to create notebook server
@Description	create notebook server
@Tags			notebook server
@Produce		application/json
@Router			/workspace/{workspace-id}/notebookserver [post]
@Security		basicAuth
@Param			workspace-id	path		string			true	"workspace id "
@Param			request			body		createRequest	true	"notebook server settings"
@Success		201				{object}	createResponse
@Failure		400				{object}	apperrors.AppError	"invalid param"
@Failure		401				{object}	apperrors.AppError	"unauthorized"
@Failure		403				{object}	apperrors.AppError	"forbidden"
@Failure		500				{object}	apperrors.AppError	"internal system error"

func DeleteNotebookServer

func DeleteNotebookServer(ctx context.Context, c *app.RequestContext, handler command.DeleteHandler)

DeleteNotebookServer delete notebook server

@Summary		use to delete notebook server
@Description	delete notebook server
@Tags			notebook server
@Produce		application/json
@Router			/workspace/{workspace-id}/notebookserver/{id} [delete]
@Security		basicAuth
@Param			workspace-id	path	string	true	"workspace id "
@Param			id				path	string	true	"notebook server id"
@Success		202
@Failure		400	{object}	apperrors.AppError	"invalid param"
@Failure		401	{object}	apperrors.AppError	"unauthorized"
@Failure		403	{object}	apperrors.AppError	"forbidden"
@Failure		500	{object}	apperrors.AppError	"internal system error"

func GetNotebookServer

func GetNotebookServer(ctx context.Context, c *app.RequestContext, handler query.GetHandler)

GetNotebookServer get notebook server of workspace

@Summary		use to get notebook server
@Description	get notebook server
@Tags			notebook server
@Produce		application/json
@Router			/workspace/{workspace-id}/notebookserver/{id} [get]
@Security		basicAuth
@Param			workspace-id	path		string	true	"workspace id "
@Param			id				path		string	true	"notebook server id"
@Param			notebook		query		string	false	"notebook object to edit"
@Success		200				{object}	getResponse
@Failure		400				{object}	apperrors.AppError	"invalid param"
@Failure		401				{object}	apperrors.AppError	"unauthorized"
@Failure		403				{object}	apperrors.AppError	"forbidden"
@Failure		500				{object}	apperrors.AppError	"internal system error"

func ListNotebookServers

func ListNotebookServers(ctx context.Context, c *app.RequestContext, handler query.ListHandler)

ListNotebookServers list notebook server of workspace

@Summary		use to list notebook server
@Description	list notebook server
@Tags			notebook server
@Produce		application/json
@Router			/workspace/{workspace-id}/notebookserver [get]
@Security		basicAuth
@Param			workspace-id	path		string	true	"workspace id "
@Success		200				{object}	[]listResponseItem
@Failure		400				{object}	apperrors.AppError	"invalid param"
@Failure		401				{object}	apperrors.AppError	"unauthorized"
@Failure		403				{object}	apperrors.AppError	"forbidden"
@Failure		500				{object}	apperrors.AppError	"internal system error"

func NewRouteRegister

func NewRouteRegister(service *application.Service) server.RouteRegister

func SwitchNotebookServer

func SwitchNotebookServer(ctx context.Context, c *app.RequestContext, handler command.SwitchHandler)

SwitchNotebookServer switch notebook server

@Summary		use to turn notebook server on or off
@Description	turn notebook server on or off
@Tags			notebook server
@Produce		application/json
@Router			/workspace/{workspace-id}/notebookserver/{id} [post]
@Security		basicAuth
@Param			workspace-id	path	string	true	"workspace id "
@Param			id				path	string	true	"notebook server id"
@Param			on				query	boolean	false	"turn on notebook server"
@Param			off				query	boolean	false	"turn off notebook server"
@Success		202
@Failure		400	{object}	apperrors.AppError	"invalid param"
@Failure		401	{object}	apperrors.AppError	"unauthorized"
@Failure		403	{object}	apperrors.AppError	"forbidden"
@Failure		500	{object}	apperrors.AppError	"internal system error"

func UpdateNotebookServerSettings

func UpdateNotebookServerSettings(ctx context.Context, c *app.RequestContext, handler command.UpdateHandler)

UpdateNotebookServerSettings update notebook server settings

@Summary		use to update notebook server settings
@Description	update notebook server settings
@Tags			notebook server
@Produce		application/json
@Router			/workspace/{workspace-id}/notebookserver/{id} [put]
@Security		basicAuth
@Param			workspace-id	path	string					true	"workspace id "
@Param			id				path	string					true	"notebook server id"
@Param			request			body	updateSettingsRequest	true	"notebook server settings"
@Success		202
@Failure		400	{object}	apperrors.AppError	"invalid param"
@Failure		401	{object}	apperrors.AppError	"unauthorized"
@Failure		403	{object}	apperrors.AppError	"forbidden"
@Failure		500	{object}	apperrors.AppError	"internal system error"