Documentation
¶
Index ¶
- type Handler
- func (h *Handler) CreateVariableSet() http.HandlerFunc
- func (h *Handler) DeleteVariableSet() http.HandlerFunc
- func (h *Handler) GetVariableSet() http.HandlerFunc
- func (h *Handler) ListVariableSets() http.HandlerFunc
- func (h *Handler) ListVariableSetsByLabels() http.HandlerFunc
- func (h *Handler) UpdateVariableSet() http.HandlerFunc
- type VariableSetRequestParams
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( variableSetManager *variableset.VariableSetManager, ) (*Handler, error)
func (*Handler) CreateVariableSet ¶
func (h *Handler) CreateVariableSet() http.HandlerFunc
@Id createVariableSet @Summary Create variable set @Description Create a new variable set @Tags variable_set @Accept json @Produce json @Param variableSet body request.CreateVariableSetRequest true "Created variable set" @Success 200 {object} handler.Response{data=entity.VariableSet} "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/variablesets [post]
func (*Handler) DeleteVariableSet ¶
func (h *Handler) DeleteVariableSet() http.HandlerFunc
@Id deleteVariableSet @Summary Delete variable set @Description Delete the specified variable set by name @Tags variable_set @Produce json @Param variableSetName path string true "Variable Set 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/variablesets/{variableSetName} [delete]
func (*Handler) GetVariableSet ¶
func (h *Handler) GetVariableSet() http.HandlerFunc
@Id getVariableSet @Summary Get variable set @Description Get variable set information by variable set name @Tags variable_set @Produce json @Param variableSetName path string true "Variable Set Name" @Success 200 {object} handler.Response{data=entity.VariableSet} "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/variablesets/{variableSetName} [get]
func (*Handler) ListVariableSets ¶
func (h *Handler) ListVariableSets() http.HandlerFunc
@Id listVariableSets @Summary List variable sets @Description List variable set information @Tags variable_set @Produce json @Param variableSetName query string false "Variable Set Name" @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 descending query bool false "Whether to sort the list in descending order. Default to false" @Param fetchAll query bool false "Whether to list all the variable sets" @Success 200 {object} handler.Response{data=response.PaginatedVariableSetResponse} "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/variablesets [get]
func (*Handler) ListVariableSetsByLabels ¶
func (h *Handler) ListVariableSetsByLabels() http.HandlerFunc
@Id listVariableSetsByLabels @Summary List variable sets by labels @Description List variable set information by label selectors @Tags variable_set @Produce json @Param selector query string true "Label selectors to match variable sets" @Success 200 {object} handler.Response{data=response.PaginatedVariableSetResponse} "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/variablesets/matched [get]
func (*Handler) UpdateVariableSet ¶
func (h *Handler) UpdateVariableSet() http.HandlerFunc
@Id updateVariableSet @Summary Update variable set @Description Update the specified variable set with name @Tags variable_set @Accept json @Produce json @Param variableSetName path string true "Variable Set Name" @Param variableSet body request.UpdateVariableSetRequest true "Updated variable set" @Success 200 {object} handler.Response{data=entity.VariableSet} "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/variablesets/{variableSetName} [put]
type VariableSetRequestParams ¶
type VariableSetRequestParams struct {
VariableSetName string
}
Source Files