api

func (LivenessHandler) Alive ¶

func (h LivenessHandler) Alive(w http.ResponseWriter, r *http.Request)

Alive godoc @Summary API liveness check @Description Will return success to indicate REST API module is live @tags util @Produce json @Param X-Request-ID header string false "Request ID" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /liveness/alive [get]

func (LivenessHandler) Ready ¶

func (h LivenessHandler) Ready(w http.ResponseWriter, r *http.Request)

Ready godoc @Summary API readiness check @Description Will return success to indicate REST API module is ready @tags util @Produce json @Param X-Request-ID header string false "Request ID" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /liveness/ready [get]

func (MCPDockerDriverSettings) ToDriverParams ¶ added in v0.2.0

func (s MCPDockerDriverSettings) ToDriverParams() models.SessionDriverDockerParams

ToDriverParams project the restricted agent-facing settings onto the full docker driver parameters. Fields not exposed to the agent are left at their zero value so the driver applies its hardened defaults (read-only rootfs, all capabilities dropped, no host mounts, no-new-privileges, etc.).

func (MCPHandler) RegisterTools ¶ added in v0.2.0

func (h MCPHandler) RegisterTools(server *mcp.Server) error

RegisterTools register all session MCP tools against the given MCP server.

@param server *mcp.Server - target MCP server

func (SessionIOCore) GetSessionOutputBuffer ¶ added in v0.2.0

func (c SessionIOCore) GetSessionOutputBuffer(
	ctx context.Context, sessionName string,
) (goutilsRedis.RingBuffer, error)

GetSessionOutputBuffer fetch a session by name and return a handle to its output ring buffer. This is the transport-agnostic entry point for callers that drive their own reads against the buffer (e.g. the REST tail streamer), where the per-read length is chosen by the caller rather than by a "limit" parameter. Errors are returned wrapped: a goutils.NotFoundError if the session is unknown.

@param ctx context.Context - execution context
@param sessionName string - the name of the session whose output buffer to fetch
@returns the ring buffer handle

func (SessionIOCore) ReadSessionOutputChunk ¶ added in v0.2.0

func (c SessionIOCore) ReadSessionOutputChunk(
	ctx context.Context, sessionName string, offset int64, limit int, stripANSI bool,
) (SessionOutputRead, error)

ReadSessionOutputChunk read one chunk of data from a session's output ring buffer, starting at the given offset. As the buffer only retains the most recent bytes, the requested offset may have aged out; in that case the read is moved forward and the returned ActualOffset reports where the data starts. Errors are returned as-is: a goutils.NotFoundError if the session is unknown.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to read from
@param offset int64 - the stream offset to start reading at
@param limit int - the max number of bytes to read
@param stripANSI bool - whether to strip ANSI escape sequences from the returned data
@returns the read result

func (SessionIOCore) ReadSessionOutputNewest ¶ added in v0.2.0

func (c SessionIOCore) ReadSessionOutputNewest(
	ctx context.Context, sessionName string, limit int, stripANSI bool,
) (SessionOutputRead, error)

ReadSessionOutputNewest read the newest bytes from a session's output ring buffer. Unlike ReadSessionOutputChunk no offset is given; the read is anchored to the end of the stream and returns up to "limit" of the most recently written bytes. The returned ActualOffset reports the stream position the returned data starts at. Errors are returned as-is: a goutils.NotFoundError if the session is unknown.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to read from
@param limit int - the max number of bytes to read
@param stripANSI bool - whether to strip ANSI escape sequences from the returned data
@returns the read result

func (SessionIOCore) SubmitUserCommandToSession ¶ added in v0.2.0

func (c SessionIOCore) SubmitUserCommandToSession(
	ctx context.Context, sessionName string, commands []models.SessionInputCommand,
) error

SubmitUserCommandToSession submit a batch of user commands to a session's runner and wait for the runner's acknowledgement, exchanged over the redis IPC queues.

The session must exist and be in the READY state to accept commands. Errors are returned as-is: a goutils.NotFoundError if the session is unknown, a goutils.ConsistencyError if the session is not ready, and other errors for IPC / runner failures.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to submit commands to
@param commands []models.SessionInputCommand - the commands to submit
@returns error encountered while submitting the commands

func (SessionIOHandler) ReadSessionOutputChunk ¶

func (h SessionIOHandler) ReadSessionOutputChunk(w http.ResponseWriter, r *http.Request)

ReadSessionOutputChunk godoc @Summary Read one chunk of session output @Description Read one chunk of data from a session's output ring buffer. As the buffer only @Description retains the most recent bytes, the requested offset may have aged out; in that @Description case the read is moved forward and "actual_offset" reports where the data starts. @tags io @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param offset query int true "Read index position within the session output stream" @Param limit query int true "Max number of bytes to read" @Param strip_ansi query bool false "Strip ANSI escape sequences from the returned data" @Success 200 {object} SessionOutputChunkResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/io/output/chunk [get]

func (SessionIOHandler) ReadSessionOutputNewest ¶

func (h SessionIOHandler) ReadSessionOutputNewest(w http.ResponseWriter, r *http.Request)

ReadSessionOutputNewest godoc @Summary Read the newest session output @Description Read the newest bytes from a session's output ring buffer. Unlike the "chunk" @Description endpoint no offset is given; the read is anchored to the end of the stream and @Description returns up to "limit" of the most recently written bytes. "actual_offset" reports @Description the stream position the returned data starts at. @tags io @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param limit query int true "Max number of bytes to read" @Param strip_ansi query bool false "Strip ANSI escape sequences from the returned data" @Success 200 {object} SessionOutputChunkResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/io/output/newest [get]

func (SessionIOHandler) SubmitUserCommandToSession ¶

func (h SessionIOHandler) SubmitUserCommandToSession(w http.ResponseWriter, r *http.Request)

SubmitUserCommandToSession godoc @Summary Submit user commands @Description Submit user commands to session runner @tags io @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param param body UserCommandRequest true "User commands" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 409 {object} goutils.RestAPIBaseResponse "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/io/input/commands [post]

func (SessionIOHandler) TailSessionOutput ¶

func (h SessionIOHandler) TailSessionOutput(w http.ResponseWriter, r *http.Request)

TailSessionOutput godoc @Summary Tail session output @Description Continuously stream a session's output via server-sent events (SSE). Each event @Description carries a base64 encoded chunk of bytes read from the output ring buffer. The @Description stream runs until the client disconnects. @tags io @Produce text/event-stream @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param offset query int true "Read index position to start tailing from" @Param poll_period_msec query int false "Milliseconds between buffer data availability checks (default 250)" @Param strip_ansi query bool false "Strip ANSI escape sequences from the streamed data" @Success 200 {string} string "SSE stream" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/io/output/tail [get]

func (SessionManagerCore) DefineNewSession ¶ added in v0.2.0

func (c SessionManagerCore) DefineNewSession(
	ctx context.Context, params NewSessionRequest,
) (models.Session, error)

DefineNewSession define a new session.

The parameters and the driver metadata are validated before the session is created; parse and validation failures are reported as a goutils.ValidationError.

@param ctx context.Context - execution context
@param params NewSessionRequest - the new session parameters
@returns the newly defined session, or a goutils.ValidationError if the parameters are
	invalid

func (SessionManagerCore) DeleteSession ¶ added in v0.2.0

func (c SessionManagerCore) DeleteSession(ctx context.Context, sessionName string) error

DeleteSession delete a session. Only permitted on IDLE sessions.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to delete
@returns goutils.NotFoundError if the session is unknown, goutils.ConsistencyError if the
	session is not in a state allowing deletion

func (SessionManagerCore) GetSession ¶ added in v0.2.0

func (c SessionManagerCore) GetSession(
	ctx context.Context, sessionName string,
) (models.Session, error)

GetSession fetch one session by its name.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to fetch
@returns the session, or a goutils.NotFoundError if no such session exists

func (SessionManagerCore) ListSessions ¶ added in v0.2.0

func (c SessionManagerCore) ListSessions(
	ctx context.Context, filters db.SessionQueryFilter,
) ([]models.Session, error)

ListSessions list the known sessions matching the given filter.

The filter is validated before the query is run; an invalid filter is reported as a goutils.ValidationError so callers can distinguish bad input from a query failure.

@param ctx context.Context - execution context
@param filters db.SessionQueryFilter - filtering and ordering to apply
@returns the matching sessions

func (SessionManagerCore) Ready ¶ added in v0.2.0

func (c SessionManagerCore) Ready(ctx context.Context) error

Ready run the persistence-layer readiness check.

@param ctx context.Context - execution context
@returns error if the persistence layer is not ready

func (SessionManagerCore) StartSession ¶ added in v0.2.0

func (c SessionManagerCore) StartSession(
	ctx context.Context, sessionName string, blocking bool,
) error

StartSession bring up a session runner for an existing session and start it, applied through the session manager.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to start
@param blocking bool - whether to wait for the start to complete
@returns goutils.NotFoundError if the session is unknown, goutils.ConsistencyError if the
	session is not in a state allowing start

func (SessionManagerCore) StopSession ¶ added in v0.2.0

func (c SessionManagerCore) StopSession(
	ctx context.Context, sessionName string, blocking bool,
) error

StopSession bring a session back to IDLE and unload its runner, applied through the session manager.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to stop
@param blocking bool - whether to wait for the stop to complete
@returns goutils.NotFoundError if the session is unknown, goutils.ConsistencyError if the
	session is not in a state allowing stop

func (SessionManagerCore) UpdateSessionCommand ¶ added in v0.2.0

func (c SessionManagerCore) UpdateSessionCommand(
	ctx context.Context, sessionName string, newCommand models.SessionCommand,
) error

UpdateSessionCommand change the command a session runs. Only permitted on IDLE sessions.

The command is validated before the change is applied; an invalid command is reported as a goutils.ValidationError.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to update
@param newCommand models.SessionCommand - the new command
@returns goutils.ValidationError if the command is invalid, goutils.NotFoundError if the
	session is unknown, goutils.ConsistencyError if the session is not in a state
	allowing the change

func (SessionManagerCore) UpdateSessionDescription ¶ added in v0.2.0

func (c SessionManagerCore) UpdateSessionDescription(
	ctx context.Context, sessionName string, description *string,
) error

UpdateSessionDescription change the description of a session.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to update
@param description *string - the new description, or nil to clear it
@returns goutils.NotFoundError if the session is unknown

func (SessionManagerCore) UpdateSessionDriver ¶ added in v0.2.0

func (c SessionManagerCore) UpdateSessionDriver(
	ctx context.Context,
	sessionName string,
	driverType models.SessionDriverTypeENUMType,
	rawMetadata json.RawMessage,
) error

UpdateSessionDriver change the driver a session uses, along with its setup metadata. Only permitted on IDLE sessions.

The driver metadata is parsed and validated for the given driver type before the change is applied; parse/validation failures are reported as a goutils.ValidationError.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to update
@param driverType models.SessionDriverTypeENUMType - the new driver type
@param rawMetadata json.RawMessage - the raw driver metadata JSON
@returns goutils.ValidationError if the driver parameters are invalid, goutils.NotFoundError
	if the session is unknown, goutils.ConsistencyError if the session is not in a state
	allowing the change

func (SessionManagerCore) UpdateSessionName ¶ added in v0.2.0

func (c SessionManagerCore) UpdateSessionName(
	ctx context.Context, sessionName string, newName string,
) error

UpdateSessionName change the name of a session.

The new name is validated before the change is applied; an invalid name is reported as a goutils.ValidationError.

@param ctx context.Context - execution context
@param sessionName string - the current name of the session to update
@param newName string - the new session name
@returns goutils.ValidationError if the name is invalid, goutils.NotFoundError if the
	session is unknown

func (SessionManagerCore) UpdateSessionOutputBufCapacity ¶ added in v0.2.0

func (c SessionManagerCore) UpdateSessionOutputBufCapacity(
	ctx context.Context, sessionName string, newCapacity int64, blocking bool,
) error

UpdateSessionOutputBufCapacity change the output buffer capacity of a session, applied through the session manager. Only permitted on IDLE sessions.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to update
@param newCapacity int64 - the new output buffer capacity
@param blocking bool - whether to wait for the change to complete
@returns goutils.NotFoundError if the session is unknown, goutils.ConsistencyError if
	the session is not in a state allowing the change

func (SessionManagerCore) UpdateSessionRunMode ¶ added in v0.2.0

func (c SessionManagerCore) UpdateSessionRunMode(
	ctx context.Context, sessionName string, newMode models.SessionRunnerModeTypeENUMType,
) error

UpdateSessionRunMode change the runner mode of a session. Only permitted on IDLE sessions.

The mode is validated before the change is applied; an invalid mode is reported as a goutils.ValidationError.

@param ctx context.Context - execution context
@param sessionName string - the name of the session to update
@param newMode models.SessionRunnerModeTypeENUMType - the new runner mode
@returns goutils.ValidationError if the mode is invalid, goutils.NotFoundError if the
	session is unknown, goutils.ConsistencyError if the session is not in a state
	allowing the change

func (SessionManagerHandler) Alive ¶

func (h SessionManagerHandler) Alive(w http.ResponseWriter, r *http.Request)

Alive godoc @Summary API liveness check @Description Will return success to indicate REST API module is live @tags util @Produce json @Param X-Request-ID header string false "Request ID" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /liveness/alive [get]

func (SessionManagerHandler) DefineNewSession ¶

func (h SessionManagerHandler) DefineNewSession(w http.ResponseWriter, r *http.Request)

DefineNewSession godoc @Summary Define a new session @Description Define a new session @tags management @Accept json @Produce json @Param X-Request-ID header string false "Request ID" @Param param body NewSessionRequest true "Session parameters" @Success 200 {object} SessionEntryResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions [post]

func (SessionManagerHandler) DeleteSession ¶

func (h SessionManagerHandler) DeleteSession(w http.ResponseWriter, r *http.Request)

DeleteSession godoc @Summary Delete a session @Description Delete a session. Only permitted on IDLE sessions. @tags management @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 409 {object} goutils.RestAPIBaseResponse "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName} [delete]

func (SessionManagerHandler) GetSession ¶

func (h SessionManagerHandler) GetSession(w http.ResponseWriter, r *http.Request)

GetSession godoc @Summary Get one session @Description Fetch one session by its name @tags management @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Success 200 {object} SessionEntryResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName} [get]

func (SessionManagerHandler) ListSessions ¶

func (h SessionManagerHandler) ListSessions(w http.ResponseWriter, r *http.Request)

ListSessions godoc @Summary List sessions @Description List the known sessions, with optional filtering and ordering @tags management @Produce json @Param X-Request-ID header string false "Request ID" @Param name query string false "Filter by sessions whose name is similar to this, case insensitive" @Param offset query int false "Number of leading entries to skip" @Param limit query int false "Max number of entries to return" @Param driver query []string false "Filter by session driver type" collectionFormat(multi) @Param state query []string false "Filter by session state" collectionFormat(multi) @Param order_by_name query bool false "Whether to order the results by session name" @Param order_dir query string false "Ordering direction, defaults to 'ASC'" Enums(asc, desc, ASC, DESC) @Success 200 {object} SessionListResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions [get]

func (SessionManagerHandler) Ready ¶

func (h SessionManagerHandler) Ready(w http.ResponseWriter, r *http.Request)

Ready godoc @Summary API readiness check @Description Will return success to indicate REST API module is ready @tags util @Produce json @Param X-Request-ID header string false "Request ID" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /liveness/ready [get]

func (SessionManagerHandler) StartSession ¶

func (h SessionManagerHandler) StartSession(w http.ResponseWriter, r *http.Request)

StartSession godoc @Summary Start a session @Description Bring up a session runner for an existing session and start it. By default @Description the request to the session manager is non-blocking; set "block" to true to @Description wait for the start to complete. @tags management @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param block query bool false "Whether to block until the start completes" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 409 {object} goutils.RestAPIBaseResponse "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/start [post]

func (SessionManagerHandler) StopSession ¶

func (h SessionManagerHandler) StopSession(w http.ResponseWriter, r *http.Request)

StopSession godoc @Summary Stop a session @Description Bring a session back to IDLE and unload its runner. By default the request @Description to the session manager is non-blocking; set "block" to true to wait for the @Description stop to complete. @tags management @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param block query bool false "Whether to block until the stop completes" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 409 {object} goutils.RestAPIBaseResponse "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/stop [post]

func (SessionManagerHandler) UpdateSessionCommand ¶

func (h SessionManagerHandler) UpdateSessionCommand(w http.ResponseWriter, r *http.Request)

UpdateSessionCommand godoc @Summary Change session command @Description Change the command a session runs. Only permitted on IDLE sessions. @tags management @Accept json @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param param body models.SessionCommand true "New session command" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 409 {object} goutils.RestAPIBaseResponse "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/command [put]

func (SessionManagerHandler) UpdateSessionDescription ¶

func (h SessionManagerHandler) UpdateSessionDescription(w http.ResponseWriter, r *http.Request)

UpdateSessionDescription godoc @Summary Change session description @Description Change the description of a session @tags management @Accept json @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param param body UpdateSessionDescriptionRequest true "New session description" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/description [put]

func (SessionManagerHandler) UpdateSessionDriver ¶

func (h SessionManagerHandler) UpdateSessionDriver(w http.ResponseWriter, r *http.Request)

UpdateSessionDriver godoc @Summary Change session driver @Description Change the driver a session uses, along with its setup metadata. Only permitted on IDLE sessions. @tags management @Accept json @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param param body UpdateSessionDriverRequest true "New session driver parameters" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 409 {object} goutils.RestAPIBaseResponse "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/driver [put]

func (SessionManagerHandler) UpdateSessionName ¶

func (h SessionManagerHandler) UpdateSessionName(w http.ResponseWriter, r *http.Request)

UpdateSessionName godoc @Summary Change session name @Description Change the name of a session @tags management @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param name query string true "New session name, can only contain alphanumeric characters and -" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/name [put]

func (SessionManagerHandler) UpdateSessionOutputBufCapacity ¶

func (h SessionManagerHandler) UpdateSessionOutputBufCapacity(
	w http.ResponseWriter, r *http.Request,
)

UpdateSessionOutputBufCapacity godoc @Summary Change session output buffer capacity @Description Change the output buffer capacity of a session. Only permitted on IDLE sessions. @Description The change is performed through the session manager; by default the request is @Description non-blocking, set "block" to true to wait for the change to complete. @tags management @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param capacity query int true "New output buffer capacity" @Param block query bool false "Whether to block until the change completes" @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 409 {object} goutils.RestAPIBaseResponse "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/output-buf-cap [put]

func (SessionManagerHandler) UpdateSessionRunMode ¶

func (h SessionManagerHandler) UpdateSessionRunMode(w http.ResponseWriter, r *http.Request)

UpdateSessionRunMode godoc @Summary Change session runner mode @Description Change the runner mode of a session. Only permitted on IDLE sessions. @tags management @Produce json @Param X-Request-ID header string false "Request ID" @Param sessionName path string true "Session name" @Param mode query string true "New session runner mode" Enums(COMMANDED, BY_PASSED) @Success 200 {object} goutils.RestAPIBaseResponse "success" @Failure 400 {object} goutils.RestAPIBaseResponse "error" @Failure 403 {object} goutils.RestAPIBaseResponse "error" @Failure 404 {string} string "error" @Failure 409 {object} goutils.RestAPIBaseResponse "error" @Failure 500 {object} goutils.RestAPIBaseResponse "error" @Router /v1/sessions/{sessionName}/run-mode [put]