feat: Add IssueService.DeleteWorklogRecord

andygrunwald · Aug 27, 2024 · b2766e3 · b2766e3
1 parent 2aa3adf
commit b2766e3
Show file tree

Hide file tree

Showing 4 changed files with 94 additions and 0 deletions.
diff --git a/cloud/issue.go b/cloud/issue.go
@@ -956,6 +956,36 @@ func (s *IssueService) DeleteComment(ctx context.Context, issueID, commentID str
 	return nil
 }
 
+// DeleteWorklogRecord Deletes a work log from an issueID.
+//
+// Jira API docs:https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs/#api-rest-api-3-issue-issueidorkey-worklog-id-delete
+//
+// TODO Double check this method if this works as expected, is using the latest API and the response is complete
+// This double check effort is done for v2 - Remove this two lines if this is completed.
+func (s *IssueService) DeleteWorklogRecord(ctx context.Context, issueID, worklogID string, options ...func(*http.Request) error) error {
+	apiEndpoint := fmt.Sprintf("rest/api/2/issue/%s/worklog/%s", issueID, worklogID)
+	req, err := s.client.NewRequest(ctx, http.MethodDelete, apiEndpoint, nil)
+	if err != nil {
+		return err
+	}
+
+	for _, option := range options {
+		err = option(req)
+		if err != nil {
+			return err
+		}
+	}
+
+	resp, err := s.client.Do(req, nil)
+	if err != nil {
+		jerr := NewJiraError(resp, err)
+		return jerr
+	}
+	defer resp.Body.Close()
+
+	return nil
+}
+
 // AddWorklogRecord adds a new worklog record to issueID.
 //
 // https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-worklog-post

diff --git a/cloud/issue_test.go b/cloud/issue_test.go
@@ -250,6 +250,23 @@ func TestIssueService_DeleteComment(t *testing.T) {
 	}
 }
 
+func TestIssueService_DeleteWorklogRecord(t *testing.T) {
+	setup()
+	defer teardown()
+	testMux.HandleFunc("/rest/api/2/issue/10000/worklog/10001", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, http.MethodDelete)
+		testRequestURL(t, r, "/rest/api/2/issue/10000/worklog/10001")
+
+		w.WriteHeader(http.StatusNoContent)
+		fmt.Fprint(w, `{}`)
+	})
+
+	err := testClient.Issue.DeleteWorklogRecord(context.Background(), "10000", "10001")
+	if err != nil {
+		t.Errorf("Error given: %s", err)
+	}
+}
+
 func TestIssueService_AddWorklogRecord(t *testing.T) {
 	setup()
 	defer teardown()

diff --git a/onpremise/issue.go b/onpremise/issue.go
@@ -955,6 +955,36 @@ func (s *IssueService) DeleteComment(ctx context.Context, issueID, commentID str
 	return nil
 }
 
+// DeleteWorklogRecord Deletes a work log from an issueID.
+//
+// Jira API docs:https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs/#api-rest-api-3-issue-issueidorkey-worklog-id-delete
+//
+// TODO Double check this method if this works as expected, is using the latest API and the response is complete
+// This double check effort is done for v2 - Remove this two lines if this is completed.
+func (s *IssueService) DeleteWorklogRecord(ctx context.Context, issueID, worklogID string, options ...func(*http.Request) error) error {
+	apiEndpoint := fmt.Sprintf("rest/api/2/issue/%s/worklog/%s", issueID, worklogID)
+	req, err := s.client.NewRequest(ctx, http.MethodDelete, apiEndpoint, nil)
+	if err != nil {
+		return err
+	}
+
+	for _, option := range options {
+		err = option(req)
+		if err != nil {
+			return err
+		}
+	}
+
+	resp, err := s.client.Do(req, nil)
+	if err != nil {
+		jerr := NewJiraError(resp, err)
+		return jerr
+	}
+	defer resp.Body.Close()
+
+	return nil
+}
+
 // AddWorklogRecord adds a new worklog record to issueID.
 //
 // https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-worklog-post

diff --git a/onpremise/issue_test.go b/onpremise/issue_test.go
@@ -250,6 +250,23 @@ func TestIssueService_DeleteComment(t *testing.T) {
 	}
 }
 
+func TestIssueService_DeleteWorklogRecord(t *testing.T) {
+	setup()
+	defer teardown()
+	testMux.HandleFunc("/rest/api/2/issue/10000/worklog/10001", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, http.MethodDelete)
+		testRequestURL(t, r, "/rest/api/2/issue/10000/worklog/10001")
+
+		w.WriteHeader(http.StatusNoContent)
+		fmt.Fprint(w, `{}`)
+	})
+
+	err := testClient.Issue.DeleteWorklogRecord(context.Background(), "10000", "10001")
+	if err != nil {
+		t.Errorf("Error given: %s", err)
+	}
+}
+
 func TestIssueService_AddWorklogRecord(t *testing.T) {
 	setup()
 	defer teardown()