diff --git a/Octokit.Tests/Clients/Enterprise/EnterpriseAdminStatsClientTest.cs b/Octokit.Tests/Clients/Enterprise/EnterpriseAdminStatsClientTest.cs index 37535133..25a0abe7 100644 --- a/Octokit.Tests/Clients/Enterprise/EnterpriseAdminStatsClientTest.cs +++ b/Octokit.Tests/Clients/Enterprise/EnterpriseAdminStatsClientTest.cs @@ -19,11 +19,11 @@ namespace Octokit.Tests.Clients var connection = Substitute.For(); var client = new EnterpriseAdminStatsClient(connection); - foreach (AdminStatsType adminType in Enum.GetValues(typeof(AdminStatsType))) + foreach (AdminStatsType type in Enum.GetValues(typeof(AdminStatsType))) { - client.GetStatistics(adminType); + client.GetStatistics(type); - connection.Received().Get(Arg.Is(u => u.ToString() == String.Concat("enterprise/stats/", adminType.ToString().ToLowerInvariant())), null); + connection.Received().Get(Arg.Is(u => u == "enterprise/stats/{0}".FormatUri(type.ToString().ToLowerInvariant())), null); } } } diff --git a/Octokit/Clients/Enterprise/EnterpriseAdminStatsClient.cs b/Octokit/Clients/Enterprise/EnterpriseAdminStatsClient.cs index 85d86cf2..e9ee1895 100644 --- a/Octokit/Clients/Enterprise/EnterpriseAdminStatsClient.cs +++ b/Octokit/Clients/Enterprise/EnterpriseAdminStatsClient.cs @@ -7,6 +7,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Enterprise Admin Stats API + /// + /// + /// See the Enterprise Admin Stats API documentation for more information. + /// public class EnterpriseAdminStatsClient : ApiClient, IEnterpriseAdminStatsClient { public EnterpriseAdminStatsClient(IApiConnection apiConnection) @@ -14,7 +20,7 @@ namespace Octokit { } /// - /// Gets all email addresses for the authenticated user. + /// Gets GitHub Enterprise statistics (must be Site Admin user). /// /// ///https://developer.github.com/v3/enterprise/admin_stats/#get-statistics diff --git a/Octokit/Clients/Enterprise/EnterpriseClient.cs b/Octokit/Clients/Enterprise/EnterpriseClient.cs index 99ab9604..add12d93 100644 --- a/Octokit/Clients/Enterprise/EnterpriseClient.cs +++ b/Octokit/Clients/Enterprise/EnterpriseClient.cs @@ -4,10 +4,10 @@ using System.Threading.Tasks; namespace Octokit { /// - /// A client for GitHub's Users API. + /// A client for GitHub's Enterprise API. /// /// - /// See the Users API documentation for more information. + /// See the Enterprise API documentation for more information. /// public class EnterpriseClient : ApiClient, IEnterpriseClient { @@ -23,7 +23,7 @@ namespace Octokit } /// - /// A client for GitHub's Enterprise AdminStats API + /// A client for GitHub's Enterprise Admin Stats API /// /// /// See the Enterprise Admin Stats API documentation for more information. diff --git a/Octokit/Clients/Enterprise/IEnterpriseAdminStatsClient.cs b/Octokit/Clients/Enterprise/IEnterpriseAdminStatsClient.cs index 36891c46..465a56ad 100644 --- a/Octokit/Clients/Enterprise/IEnterpriseAdminStatsClient.cs +++ b/Octokit/Clients/Enterprise/IEnterpriseAdminStatsClient.cs @@ -6,8 +6,21 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Enterprise Admin Stats API + /// + /// + /// See the Enterprise Admin Stats API documentation for more information. + /// public interface IEnterpriseAdminStatsClient { + /// + /// Gets GitHub Enterprise statistics (must be Site Admin user). + /// + /// + ///https://developer.github.com/v3/enterprise/admin_stats/#get-statistics + /// + /// The collection for the requested type. Task GetStatistics(AdminStatsType type); } diff --git a/Octokit/Clients/Enterprise/IEnterpriseClient.cs b/Octokit/Clients/Enterprise/IEnterpriseClient.cs index cfd48dfa..eaf2d3aa 100644 --- a/Octokit/Clients/Enterprise/IEnterpriseClient.cs +++ b/Octokit/Clients/Enterprise/IEnterpriseClient.cs @@ -16,7 +16,7 @@ namespace Octokit /// A client for GitHub's Enterprise Admin Stats API /// /// - /// See the Admin Stats API documentation for more information. + /// See the Enterprise Admin Stats API documentation for more information. /// IEnterpriseAdminStatsClient AdminStats { get; } }