Add endpoint to subscribe to the issue (#832)

* Add endpoint to subscribe to the issue. * Fix typo in the comment * Apply PR comment - update methods summary * Update summaries to full comments from the documentation.
ubisoft · Jan 16, 2025 · 51c1f22 · 51c1f22
1 parent 4bebb6e
commit 51c1f22
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/NGitLab.Mock/Clients/IssueClient.cs b/NGitLab.Mock/Clients/IssueClient.cs
@@ -457,6 +457,11 @@ public IEnumerable<Participant> GetParticipants(ProjectId projectId, long issueI
         throw new NotImplementedException();
     }
 
+    public Models.Issue Subscribe(ProjectId projectId, long issueIid)
+    {
+        throw new NotImplementedException();
+    }
+
     public Models.Issue Unsubscribe(ProjectId projectId, long issueIid)
     {
         throw new NotImplementedException();

diff --git a/NGitLab/IIssueClient.cs b/NGitLab/IIssueClient.cs
@@ -70,7 +70,7 @@ public interface IIssueClient
     Task<Issue> GetByIdAsync(long issueId, CancellationToken cancellationToken = default);
 
     /// <summary>
-    /// Add an issue witht he proposed title to the GitLab list for the selected proejct id.
+    /// Add an issue with the proposed title to the GitLab list for the selected project id.
     /// </summary>
     /// <param name="issueCreate"></param>
     /// <returns>The issue if it was created.  Null if not.</returns>
@@ -190,7 +190,15 @@ public interface IIssueClient
     IEnumerable<Participant> GetParticipants(ProjectId projectId, long issueIid);
 
     /// <summary>
-    /// Unsubscribe to the issue
+    /// Subscribes the authenticated user to an issue to receive notifications.
+    /// </summary>
+    /// <param name="projectId">The project id</param>
+    /// <param name="issueIid">The id of the issue in the project's scope.</param>
+    /// <returns>The issue that corresponds to the project id and issue id</returns>
+    Issue Subscribe(ProjectId projectId, long issueIid);
+
+    /// <summary>
+    /// Unsubscribes the authenticated user from the issue to not receive notifications from it.
     /// </summary>
     /// <param name="projectId">The project id</param>
     /// <param name="issueIid">The id of the issue in the project's scope.</param>

diff --git a/NGitLab/Impl/IssueClient.cs b/NGitLab/Impl/IssueClient.cs
@@ -24,6 +24,7 @@ public class IssueClient : IIssueClient
     private const string TimeStatsUrl = "/projects/{0}/issues/{1}/time_stats";
     private const string CloneIssueUrl = "/projects/{0}/issues/{1}/clone";
     private const string ParticipantsUrl = "/projects/{0}/issues/{1}/participants";
+    private const string SubscribeUrl = "/projects/{0}/issues/{1}/subscribe";
     private const string UnsubscribeUrl = "/projects/{0}/issues/{1}/unsubscribe";
 
     private readonly API _api;
@@ -199,6 +200,11 @@ public IEnumerable<Participant> GetParticipants(ProjectId projectId, long issueI
         return _api.Get().GetAll<Participant>(string.Format(CultureInfo.InvariantCulture, ParticipantsUrl, projectId.ValueAsUriParameter(), issueIid));
     }
 
+    public Issue Subscribe(ProjectId projectId, long issueIid)
+    {
+        return _api.Post().To<Issue>(string.Format(CultureInfo.InvariantCulture, SubscribeUrl, projectId.ValueAsUriParameter(), issueIid));
+    }
+
     public Issue Unsubscribe(ProjectId projectId, long issueIid)
     {
         return _api.Post().To<Issue>(string.Format(CultureInfo.InvariantCulture, UnsubscribeUrl, projectId.ValueAsUriParameter(), issueIid));

diff --git a/NGitLab/PublicAPI.Unshipped.txt b/NGitLab/PublicAPI.Unshipped.txt
@@ -320,6 +320,7 @@ NGitLab.IIssueClient.ResourceMilestoneEventsAsync(long projectId, long issueIid)
 NGitLab.IIssueClient.ResourceStateEvents(long projectId, long issueIid) -> System.Collections.Generic.IEnumerable<NGitLab.Models.ResourceStateEvent>
 NGitLab.IIssueClient.ResourceStateEventsAsync(long projectId, long issueIid) -> NGitLab.GitLabCollectionResponse<NGitLab.Models.ResourceStateEvent>
 NGitLab.IIssueClient.TimeStatsAsync(long projectId, long issueIid, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<NGitLab.Models.TimeStats>
+NGitLab.IIssueClient.Subscribe(NGitLab.Models.ProjectId projectId, long issueIid) -> NGitLab.Models.Issue
 NGitLab.IIssueClient.Unsubscribe(NGitLab.Models.ProjectId projectId, long issueIid) -> NGitLab.Models.Issue
 NGitLab.IJobClient
 NGitLab.IJobClient.Get(long jobId) -> NGitLab.Models.Job
@@ -617,6 +618,7 @@ NGitLab.Impl.IssueClient.ResourceMilestoneEventsAsync(long projectId, long issue
 NGitLab.Impl.IssueClient.ResourceStateEvents(long projectId, long issueIid) -> System.Collections.Generic.IEnumerable<NGitLab.Models.ResourceStateEvent>
 NGitLab.Impl.IssueClient.ResourceStateEventsAsync(long projectId, long issueIid) -> NGitLab.GitLabCollectionResponse<NGitLab.Models.ResourceStateEvent>
 NGitLab.Impl.IssueClient.TimeStatsAsync(long projectId, long issueIid, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<NGitLab.Models.TimeStats>
+NGitLab.Impl.IssueClient.Subscribe(NGitLab.Models.ProjectId projectId, long issueIid) -> NGitLab.Models.Issue
 NGitLab.Impl.IssueClient.Unsubscribe(NGitLab.Models.ProjectId projectId, long issueIid) -> NGitLab.Models.Issue
 NGitLab.Impl.JobClient
 NGitLab.Impl.JobClient.Get(long jobId) -> NGitLab.Models.Job