Merge pull request octokit#1375 from dampir/add-repo-id-events-client

Add repositoryId overloads to methods on I(Observable)EventsClient
michaeljolley · Jun 25, 2016 · 07190f3 · 07190f3
2 parents ca7b486 + 5db052e
commit 07190f3
Show file tree

Hide file tree

Showing 7 changed files with 786 additions and 169 deletions.
diff --git a/Octokit.Reactive/Clients/IObservableEventsClient.cs b/Octokit.Reactive/Clients/IObservableEventsClient.cs
@@ -2,6 +2,12 @@
 
 namespace Octokit.Reactive
 {
+    /// <summary>
+    /// A client for GitHub's Activity Events API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="http://developer.github.com/v3/activity/events/">Activity Events API documentation</a> for more information
+    /// </remarks>
     public interface IObservableEventsClient
     {
         /// <summary>
@@ -10,7 +16,6 @@ public interface IObservableEventsClient
         /// <remarks>
         /// http://developer.github.com/v3/activity/events/#list-public-events
         /// </remarks>
-        /// <returns>All the public <see cref="Activity"/>s for the particular user.</returns>
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
         IObservable<Activity> GetAll();
 
@@ -21,7 +26,6 @@ public interface IObservableEventsClient
         /// http://developer.github.com/v3/activity/events/#list-public-events
         /// </remarks>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the public <see cref="Activity"/>s for the particular user.</returns>        
         IObservable<Activity> GetAll(ApiOptions options);
 
         /// <summary>
@@ -32,9 +36,17 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
-        /// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
         IObservable<Activity> GetAllForRepository(string owner, string name);
 
+        /// <summary>
+        /// Gets all the events for a given repository
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
+        /// </remarks>
+        /// <param name="repositoryId">The ID of the repository</param>
+        IObservable<Activity> GetAllForRepository(int repositoryId);
+
         /// <summary>
         /// Gets all the events for a given repository
         /// </summary>
@@ -44,9 +56,18 @@ public interface IObservableEventsClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
         IObservable<Activity> GetAllForRepository(string owner, string name, ApiOptions options);
 
+        /// <summary>
+        /// Gets all the events for a given repository
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
+        /// </remarks>
+        /// <param name="repositoryId">The ID of the repository</param>
+        /// <param name="options">Options for changing the API response</param>
+        IObservable<Activity> GetAllForRepository(int repositoryId, ApiOptions options);
+
         /// <summary>
         /// Gets all the issue events for a given repository
         /// </summary>
@@ -55,9 +76,17 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
-        /// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
         IObservable<Activity> GetAllIssuesForRepository(string owner, string name);
 
+        /// <summary>
+        /// Gets all the issue events for a given repository
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
+        /// </remarks>
+        /// <param name="repositoryId">The ID of the repository</param>
+        IObservable<Activity> GetAllIssuesForRepository(int repositoryId);
+
         /// <summary>
         /// Gets all the issue events for a given repository
         /// </summary>
@@ -67,9 +96,18 @@ public interface IObservableEventsClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
         IObservable<Activity> GetAllIssuesForRepository(string owner, string name, ApiOptions options);
 
+        /// <summary>
+        /// Gets all the issue events for a given repository
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
+        /// </remarks>
+        /// <param name="repositoryId">The ID of the repository</param>
+        /// <param name="options">Options for changing the API response</param>
+        IObservable<Activity> GetAllIssuesForRepository(int repositoryId, ApiOptions options);
+
         /// <summary>
         /// Gets all the events for a given repository network
         /// </summary>
@@ -78,7 +116,6 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
-        /// <returns>All the <see cref="Activity"/>s for the particular repository network.</returns>
         IObservable<Activity> GetAllForRepositoryNetwork(string owner, string name);
 
         /// <summary>
@@ -90,7 +127,6 @@ public interface IObservableEventsClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the <see cref="Activity"/>s for the particular repository network.</returns>
         IObservable<Activity> GetAllForRepositoryNetwork(string owner, string name, ApiOptions options);
 
         /// <summary>
@@ -100,7 +136,6 @@ public interface IObservableEventsClient
         /// http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization
         /// </remarks>
         /// <param name="organization">The name of the organization</param>
-        /// <returns>All the <see cref="Activity"/>s for the particular organization.</returns>
         IObservable<Activity> GetAllForOrganization(string organization);
 
         /// <summary>
@@ -111,7 +146,6 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="organization">The name of the organization</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the <see cref="Activity"/>s for the particular organization.</returns>
         IObservable<Activity> GetAllForOrganization(string organization, ApiOptions options);
 
         /// <summary>
@@ -121,7 +155,6 @@ public interface IObservableEventsClient
         /// http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received
         /// </remarks>
         /// <param name="user">The login of the user</param>
-        /// <returns>All the <see cref="Activity"/>s that a particular user has received.</returns>
         IObservable<Activity> GetAllUserReceived(string user);
 
         /// <summary>
@@ -132,7 +165,6 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="user">The login of the user</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the <see cref="Activity"/>s that a particular user has received.</returns>
         IObservable<Activity> GetAllUserReceived(string user, ApiOptions options);
 
         /// <summary>
@@ -142,7 +174,6 @@ public interface IObservableEventsClient
         /// http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received
         /// </remarks>
         /// <param name="user">The login of the user</param>
-        /// <returns>All the <see cref="Activity"/>s that a particular user has received.</returns>
         IObservable<Activity> GetAllUserReceivedPublic(string user);
 
         /// <summary>
@@ -153,7 +184,6 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="user">The login of the user</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the <see cref="Activity"/>s that a particular user has received.</returns>
         IObservable<Activity> GetAllUserReceivedPublic(string user, ApiOptions options);
 
         /// <summary>
@@ -163,7 +193,6 @@ public interface IObservableEventsClient
         /// http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user
         /// </remarks>
         /// <param name="user">The login of the user</param>
-        /// <returns>All the <see cref="Activity"/>s that a particular user has performed.</returns>
         IObservable<Activity> GetAllUserPerformed(string user);
 
         /// <summary>
@@ -174,7 +203,6 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="user">The login of the user</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the <see cref="Activity"/>s that a particular user has performed.</returns>
         IObservable<Activity> GetAllUserPerformed(string user, ApiOptions options);
 
         /// <summary>
@@ -184,7 +212,6 @@ public interface IObservableEventsClient
         /// http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user
         /// </remarks>
         /// <param name="user">The login of the user</param>
-        /// <returns>All the public <see cref="Activity"/>s that a particular user has performed.</returns>
         IObservable<Activity> GetAllUserPerformedPublic(string user);
 
         /// <summary>
@@ -195,7 +222,6 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="user">The login of the user</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the public <see cref="Activity"/>s that a particular user has performed.</returns>
         IObservable<Activity> GetAllUserPerformedPublic(string user, ApiOptions options);
 
         /// <summary>
@@ -206,7 +232,6 @@ public interface IObservableEventsClient
         /// </remarks>
         /// <param name="user">The login of the user</param>
         /// <param name="organization">The name of the organization</param>
-        /// <returns>All the public <see cref="Activity"/>s that are associated with an organization.</returns>
         IObservable<Activity> GetAllForAnOrganization(string user, string organization);
 
         /// <summary>
@@ -218,7 +243,6 @@ public interface IObservableEventsClient
         /// <param name="user">The login of the user</param>
         /// <param name="organization">The name of the organization</param>
         /// <param name="options">Options for changing the API response</param>
-        /// <returns>All the public <see cref="Activity"/>s that are associated with an organization.</returns>
         IObservable<Activity> GetAllForAnOrganization(string user, string organization, ApiOptions options);
     }
 }