// // Copyright 2021, Arkbriar // // 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" "time" ) // IssueLinksService handles communication with the issue relations related methods // of the GitLab API. // // GitLab API docs: https://docs.gitlab.com/ee/api/issue_links.html type IssueLinksService struct { client *Client } // IssueLink represents a two-way relation between two issues. // // GitLab API docs: https://docs.gitlab.com/ee/api/issue_links.html type IssueLink struct { SourceIssue *Issue `json:"source_issue"` TargetIssue *Issue `json:"target_issue"` LinkType string `json:"link_type"` } // IssueRelation gets a relation between two issues. // // GitLab API docs: // https://docs.gitlab.com/ee/api/issue_links.html#list-issue-relations type IssueRelation struct { ID int `json:"id"` IID int `json:"iid"` State string `json:"state"` Description string `json:"description"` Confidential bool `json:"confidential"` Author *IssueAuthor `json:"author"` Milestone *Milestone `json:"milestone"` ProjectID int `json:"project_id"` Assignees []*IssueAssignee `json:"assignees"` Assignee *IssueAssignee `json:"assignee"` UpdatedAt *time.Time `json:"updated_at"` Title string `json:"title"` CreatedAt *time.Time `json:"created_at"` Labels Labels `json:"labels"` DueDate *ISOTime `json:"due_date"` WebURL string `json:"web_url"` References *IssueReferences `json:"references"` Weight int `json:"weight"` UserNotesCount int `json:"user_notes_count"` IssueLinkID int `json:"issue_link_id"` LinkType string `json:"link_type"` LinkCreatedAt *time.Time `json:"link_created_at"` LinkUpdatedAt *time.Time `json:"link_updated_at"` } // ListIssueRelations gets a list of related issues of a given issue, // sorted by the relationship creation datetime (ascending). // // Issues will be filtered according to the user authorizations. // // GitLab API docs: // https://docs.gitlab.com/ee/api/issue_links.html#list-issue-relations func (s *IssueLinksService) ListIssueRelations(pid interface{}, issue int, options ...RequestOptionFunc) ([]*IssueRelation, *Response, error) { project, err := parseID(pid) if err != nil { return nil, nil, err } u := fmt.Sprintf("projects/%s/issues/%d/links", PathEscape(project), issue) req, err := s.client.NewRequest(http.MethodGet, u, nil, options) if err != nil { return nil, nil, err } var is []*IssueRelation resp, err := s.client.Do(req, &is) if err != nil { return nil, resp, err } return is, resp, nil } // GetIssueLink gets a specific issue link. // // GitLab API docs: // https://docs.gitlab.com/ee/api/issue_links.html#get-an-issue-link func (s *IssueLinksService) GetIssueLink(pid interface{}, issue, issueLink int, options ...RequestOptionFunc) (*IssueLink, *Response, error) { project, err := parseID(pid) if err != nil { return nil, nil, err } u := fmt.Sprintf("projects/%s/issues/%d/links/%d", PathEscape(project), issue, issueLink) req, err := s.client.NewRequest(http.MethodGet, u, nil, options) if err != nil { return nil, nil, err } il := new(IssueLink) resp, err := s.client.Do(req, il) if err != nil { return nil, resp, err } return il, resp, nil } // CreateIssueLinkOptions represents the available CreateIssueLink() options. // // GitLab API docs: https://docs.gitlab.com/ee/api/issue_links.html#create-an-issue-link type CreateIssueLinkOptions struct { TargetProjectID *string `json:"target_project_id"` TargetIssueIID *string `json:"target_issue_iid"` LinkType *string `json:"link_type"` } // CreateIssueLink creates a two-way relation between two issues. // User must be allowed to update both issues in order to succeed. // // GitLab API docs: // https://docs.gitlab.com/ee/api/issue_links.html#create-an-issue-link func (s *IssueLinksService) CreateIssueLink(pid interface{}, issue int, opt *CreateIssueLinkOptions, options ...RequestOptionFunc) (*IssueLink, *Response, error) { project, err := parseID(pid) if err != nil { return nil, nil, err } u := fmt.Sprintf("projects/%s/issues/%d/links", PathEscape(project), issue) req, err := s.client.NewRequest(http.MethodPost, u, opt, options) if err != nil { return nil, nil, err } i := new(IssueLink) resp, err := s.client.Do(req, &i) if err != nil { return nil, resp, err } return i, resp, nil } // DeleteIssueLink deletes an issue link, thus removes the two-way relationship. // // GitLab API docs: // https://docs.gitlab.com/ee/api/issue_links.html#delete-an-issue-link func (s *IssueLinksService) DeleteIssueLink(pid interface{}, issue, issueLink int, options ...RequestOptionFunc) (*IssueLink, *Response, error) { project, err := parseID(pid) if err != nil { return nil, nil, err } u := fmt.Sprintf("projects/%s/issues/%d/links/%d", PathEscape(project), issue, issueLink) req, err := s.client.NewRequest(http.MethodDelete, u, nil, options) if err != nil { return nil, nil, err } il := new(IssueLink) resp, err := s.client.Do(req, &il) if err != nil { return nil, resp, err } return il, resp, nil }