// // Copyright 2021, Sander van Harmelen // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // package gitlab import ( "fmt" "net/http" ) // GroupLabelsService handles communication with the label related methods of the // GitLab API. // // GitLab API docs: https://docs.gitlab.com/ce/api/group_labels.html type GroupLabelsService struct { client *Client } // GroupLabel represents a GitLab group label. // // GitLab API docs: https://docs.gitlab.com/ce/api/group_labels.html type GroupLabel Label func (l GroupLabel) String() string { return Stringify(l) } // ListGroupLabelsOptions represents the available ListGroupLabels() options. // // GitLab API docs: https://docs.gitlab.com/ee/api/group_labels.html#list-group-labels type ListGroupLabelsOptions struct { ListOptions WithCounts *bool `url:"with_counts,omitempty" json:"with_counts,omitempty"` IncludeAncestorGroups *bool `url:"include_ancestor_groups,omitempty" json:"include_ancestor_groups,omitempty"` IncludeDescendantGrouops *bool `url:"include_descendant_groups,omitempty" json:"include_descendant_groups,omitempty"` OnlyGroupLabels *bool `url:"only_group_labels,omitempty" json:"only_group_labels,omitempty"` Search *string `url:"search,omitempty" json:"search,omitempty"` } // ListGroupLabels gets all labels for given group. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#list-group-labels func (s *GroupLabelsService) ListGroupLabels(gid interface{}, opt *ListGroupLabelsOptions, options ...RequestOptionFunc) ([]*GroupLabel, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/labels", PathEscape(group)) req, err := s.client.NewRequest(http.MethodGet, u, opt, options) if err != nil { return nil, nil, err } var l []*GroupLabel resp, err := s.client.Do(req, &l) if err != nil { return nil, resp, err } return l, resp, err } // GetGroupLabel get a single label for a given group. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#get-a-single-group-label func (s *GroupLabelsService) GetGroupLabel(gid interface{}, labelID interface{}, options ...RequestOptionFunc) (*GroupLabel, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } label, err := parseID(labelID) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/labels/%s", PathEscape(group), PathEscape(label)) req, err := s.client.NewRequest(http.MethodGet, u, nil, options) if err != nil { return nil, nil, err } var l *GroupLabel resp, err := s.client.Do(req, &l) if err != nil { return nil, resp, err } return l, resp, err } // CreateGroupLabelOptions represents the available CreateGroupLabel() options. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#create-a-new-group-label type CreateGroupLabelOptions CreateLabelOptions // CreateGroupLabel creates a new label for given group with given name and // color. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#create-a-new-group-label func (s *GroupLabelsService) CreateGroupLabel(gid interface{}, opt *CreateGroupLabelOptions, options ...RequestOptionFunc) (*GroupLabel, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/labels", PathEscape(group)) req, err := s.client.NewRequest(http.MethodPost, u, opt, options) if err != nil { return nil, nil, err } l := new(GroupLabel) resp, err := s.client.Do(req, l) if err != nil { return nil, resp, err } return l, resp, err } // DeleteGroupLabelOptions represents the available DeleteGroupLabel() options. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#delete-a-group-label type DeleteGroupLabelOptions DeleteLabelOptions // DeleteGroupLabel deletes a group label given by its name. // // GitLab API docs: https://docs.gitlab.com/ce/api/labels.html#delete-a-label func (s *GroupLabelsService) DeleteGroupLabel(gid interface{}, opt *DeleteGroupLabelOptions, options ...RequestOptionFunc) (*Response, error) { group, err := parseID(gid) if err != nil { return nil, err } u := fmt.Sprintf("groups/%s/labels", PathEscape(group)) req, err := s.client.NewRequest(http.MethodDelete, u, opt, options) if err != nil { return nil, err } return s.client.Do(req, nil) } // UpdateGroupLabelOptions represents the available UpdateGroupLabel() options. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#update-a-group-label type UpdateGroupLabelOptions UpdateLabelOptions // UpdateGroupLabel updates an existing label with new name or now color. At least // one parameter is required, to update the label. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#update-a-group-label func (s *GroupLabelsService) UpdateGroupLabel(gid interface{}, opt *UpdateGroupLabelOptions, options ...RequestOptionFunc) (*GroupLabel, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/labels", PathEscape(group)) req, err := s.client.NewRequest(http.MethodPut, u, opt, options) if err != nil { return nil, nil, err } l := new(GroupLabel) resp, err := s.client.Do(req, l) if err != nil { return nil, resp, err } return l, resp, err } // SubscribeToGroupLabel subscribes the authenticated user to a label to receive // notifications. If the user is already subscribed to the label, the status // code 304 is returned. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#subscribe-to-a-group-label func (s *GroupLabelsService) SubscribeToGroupLabel(gid interface{}, labelID interface{}, options ...RequestOptionFunc) (*GroupLabel, *Response, error) { group, err := parseID(gid) if err != nil { return nil, nil, err } label, err := parseID(labelID) if err != nil { return nil, nil, err } u := fmt.Sprintf("groups/%s/labels/%s/subscribe", PathEscape(group), PathEscape(label)) req, err := s.client.NewRequest(http.MethodPost, u, nil, options) if err != nil { return nil, nil, err } l := new(GroupLabel) resp, err := s.client.Do(req, l) if err != nil { return nil, resp, err } return l, resp, err } // UnsubscribeFromGroupLabel unsubscribes the authenticated user from a label to not // receive notifications from it. If the user is not subscribed to the label, the // status code 304 is returned. // // GitLab API docs: // https://docs.gitlab.com/ce/api/group_labels.html#unsubscribe-from-a-group-label func (s *GroupLabelsService) UnsubscribeFromGroupLabel(gid interface{}, labelID interface{}, options ...RequestOptionFunc) (*Response, error) { group, err := parseID(gid) if err != nil { return nil, err } label, err := parseID(labelID) if err != nil { return nil, err } u := fmt.Sprintf("groups/%s/labels/%s/unsubscribe", PathEscape(group), PathEscape(label)) req, err := s.client.NewRequest(http.MethodPost, u, nil, options) if err != nil { return nil, err } return s.client.Do(req, nil) }