mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-18 05:05:14 +00:00
4f0519ee13
* Add a warning to the statistics client about caching * Simplify note about caching and direct users to the API docs Also update to use summary instead of remarks * Merge the summary sections as the 2nd section is ignored in VS * squash duplicate summary tags together * Also squash these lines
81 lines
3.6 KiB
C#
81 lines
3.6 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Repository Statistics API.
|
|
/// Note that the GitHub API uses caching on these endpoints,
|
|
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/statistics/">Repository Statistics API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IObservableStatisticsClient
|
|
{
|
|
/// <summary>
|
|
/// Returns a list of <see cref="Contributor"/> for the given repository
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<IEnumerable<Contributor>> GetContributors(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Returns a list of <see cref="Contributor"/> for the given repository
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
IObservable<IEnumerable<Contributor>> GetContributors(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Returns the last year of commit activity grouped by week.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<CommitActivity> GetCommitActivity(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Returns the last year of commit activity grouped by week.
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
IObservable<CommitActivity> GetCommitActivity(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<CodeFrequency> GetCodeFrequency(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
IObservable<CodeFrequency> GetCodeFrequency(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Returns the total commit counts for the owner and total commit counts in total.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<Participation> GetParticipation(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Returns the total commit counts for the owner and total commit counts in total.
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
IObservable<Participation> GetParticipation(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Returns a list of the number of commits per hour in each day
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<PunchCard> GetPunchCard(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Returns a list of the number of commits per hour in each day
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
IObservable<PunchCard> GetPunchCard(long repositoryId);
|
|
}
|
|
} |