module

Documentation

Index

• type Handler
  • func NewHandler(moduleManager *modulemanager.ModuleManager) (*Handler, error)
  • func (h *Handler) CreateModule() http.HandlerFunc
  • func (h *Handler) DeleteModule() http.HandlerFunc
  • func (h *Handler) GetModule() http.HandlerFunc
  • func (h *Handler) ListModules() http.HandlerFunc
  • func (h *Handler) UpdateModule() http.HandlerFunc
• type ModuleRequestParams

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(
	moduleManager *modulemanager.ModuleManager,
) (*Handler, error)

func (*Handler) CreateModule

func (h *Handler) CreateModule() http.HandlerFunc

@Id createModule @Summary Create module @Description Create a new Kusion module @Tags module @Accept json @Produce json @Param module body request.CreateModuleRequest true "Created module" @Success 200 {object} handler.Response{data=entity.Module} "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/modules [post]

func (*Handler) DeleteModule

func (h *Handler) DeleteModule() http.HandlerFunc

@Id deleteModule @Summary Delete module @Description Delete the specified module by name @Tags module @Produce json @Param moduleName path string true "Module Name" @Success 200 {object} handler.Response{data=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/modules/{moduleName} [delete]

func (*Handler) GetModule

func (h *Handler) GetModule() http.HandlerFunc

@Id getModule @Summary Get module @Description Get module information by module name @Tags module @Produce json @Param moduleName path string true "Module Name" @Success 200 {object} handler.Response{data=entity.Module} "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/modules/{moduleName} [get]

func (*Handler) ListModules

func (h *Handler) ListModules() http.HandlerFunc

@Id listModule @Summary List module @Description List module information @Tags module @Produce json @Param workspaceID query uint false "Workspace ID to filter module list by. Default to all workspaces." @Param moduleName query string false "Module name to filter module list by. Default to all modules." @Param page query uint false "The current page to fetch. Default to 1" @Param pageSize query uint false "The size of the page. Default to 10" @Param sortBy query string false "Which field to sort the list by. Default to id" @Param ascending query bool false "Whether to sort the list in ascending order. Default to false" @Success 200 {object} handler.Response{data=response.PaginatedModuleResponse} "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/modules [get]

func (*Handler) UpdateModule

func (h *Handler) UpdateModule() http.HandlerFunc

@Id updateModule @Summary Update module @Description Update the specified module @Tags module @Accept json @Produce json @Param moduleName path string true "Module Name" @Param module body request.UpdateModuleRequest true "Updated module" @Success 200 {object} handler.Response{data=entity.Module} "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/modules/{moduleName} [put]

type ModuleRequestParams

type ModuleRequestParams struct {
	ModuleName  string
	WorkspaceID uint
}