Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
func NewHandler ¶
func NewHandler( workspaceManager *workspacemanager.WorkspaceManager, ) (*Handler, error)
func (*Handler) CreateWorkspace ¶
func (h *Handler) CreateWorkspace() http.HandlerFunc
@Id createWorkspace @Summary Create workspace @Description Create a new workspace @Tags workspace @Accept json @Produce json @Param workspace body request.CreateWorkspaceRequest true "Created workspace" @Success 200 {object} entity.Workspace "Success" @Failure 400 {object} error "Bad Request" @Failure 401 {object} error "Unauthorized" @Failure 429 {object} error "Too Many Requests" @Failure 404 {object} error "Not Found" @Failure 500 {object} error "Internal Server Error" @Router /api/v1/workspaces [post]
func (*Handler) DeleteWorkspace ¶
func (h *Handler) DeleteWorkspace() http.HandlerFunc
@Id deleteWorkspace @Summary Delete workspace @Description Delete specified workspace by ID @Tags workspace @Produce json @Param id path int true "Workspace ID" @Success 200 {object} string "Success" @Failure 400 {object} error "Bad Request" @Failure 401 {object} error "Unauthorized" @Failure 429 {object} error "Too Many Requests" @Failure 404 {object} error "Not Found" @Failure 500 {object} error "Internal Server Error" @Router /api/v1/workspaces/{id} [delete]
func (*Handler) GetWorkspace ¶
func (h *Handler) GetWorkspace() http.HandlerFunc
@Id getWorkspace @Summary Get workspace @Description Get workspace information by workspace ID @Tags workspace @Produce json @Param id path int true "Workspace ID" @Success 200 {object} entity.Workspace "Success" @Failure 400 {object} error "Bad Request" @Failure 401 {object} error "Unauthorized" @Failure 429 {object} error "Too Many Requests" @Failure 404 {object} error "Not Found" @Failure 500 {object} error "Internal Server Error" @Router /api/v1/workspaces/{id} [get]
func (*Handler) ListWorkspaces ¶
func (h *Handler) ListWorkspaces() http.HandlerFunc
@Id listWorkspace @Summary List workspaces @Description List all workspaces @Tags workspace @Produce json @Success 200 {object} entity.Workspace "Success" @Failure 400 {object} error "Bad Request" @Failure 401 {object} error "Unauthorized" @Failure 429 {object} error "Too Many Requests" @Failure 404 {object} error "Not Found" @Failure 500 {object} error "Internal Server Error" @Router /api/v1/workspaces [get]
func (*Handler) UpdateWorkspace ¶
func (h *Handler) UpdateWorkspace() http.HandlerFunc
@Id updateWorkspace @Summary Update workspace @Description Update the specified workspace @Tags workspace @Accept json @Produce json @Param id path int true "Workspace ID" @Param workspace body request.UpdateWorkspaceRequest true "Updated workspace" @Success 200 {object} entity.Workspace "Success" @Failure 400 {object} error "Bad Request" @Failure 401 {object} error "Unauthorized" @Failure 429 {object} error "Too Many Requests" @Failure 404 {object} error "Not Found" @Failure 500 {object} error "Internal Server Error" @Router /api/v1/workspaces/{id} [put]
type WorkspaceRequestParams ¶
type WorkspaceRequestParams struct {
WorkspaceID uint
}