mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-19 21:55:12 +00:00
49 lines
2.3 KiB
C#
49 lines
2.3 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using Octokit.Response;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
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="repositoryName">The name of the repository</param>
|
|
/// <returns>A list of <see cref="Contributor"/></returns>
|
|
IObservable<IEnumerable<Contributor>> GetContributors(string owner, string repositoryName);
|
|
|
|
/// <summary>
|
|
/// Returns the last year of commit activity grouped by week.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="repositoryName">The name of the repository</param>
|
|
/// <returns>The last year of <see cref="CommitActivity"/></returns>
|
|
IObservable<CommitActivity> GetCommitActivity(string owner, string repositoryName);
|
|
|
|
/// <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="repositoryName">The name of the repository</param>
|
|
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
|
|
IObservable<CodeFrequency> GetCodeFrequency(string owner, string repositoryName);
|
|
|
|
/// <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="repositoryName">The name of the repository</param>
|
|
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
|
|
IObservable<Participation> GetParticipation(string owner, string repositoryName);
|
|
|
|
/// <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="repositoryName">The name of the repository</param>
|
|
/// <returns>Returns commit counts per hour in each day</returns>
|
|
IObservable<PunchCard> GetPunchCard(string owner, string repositoryName);
|
|
}
|
|
} |