mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-19 21:55:12 +00:00
a57fb1278d
* Add response models * Supress message * correct spelling Timestamp * implement traffic client * add reactive client * [WIP] unit tests * add argument check * finish unit tests * add integration tests * Change repositoryId from int to long Remove GetAll naming of endpoints and add to PaginationTest exclusions Rename View and Clone classes to be more specific Add handling of TimeStamp fields being UtcUnix time Add integration tests for repositoryId methods
78 lines
3.9 KiB
C#
78 lines
3.9 KiB
C#
using System;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Repository Traffic API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/traffic/">Repository Traffic API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IObservableRepositoryTrafficClient
|
|
{
|
|
/// <summary>
|
|
/// List the top 10 referrers over the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#list-referrers</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<RepositoryTrafficReferrer> GetReferrers(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// List the top 10 referrers over the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#list-referrers</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
IObservable<RepositoryTrafficReferrer> GetReferrers(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// List the top 10 popular contents over the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#list-paths</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<RepositoryTrafficPath> GetPaths(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// List the top 10 popular contents over the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#list-paths</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
IObservable<RepositoryTrafficPath> GetPaths(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Get the total number of views and breakdown per day or week for the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#views</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="per">Breakdown per day or week</param>
|
|
IObservable<RepositoryTrafficViewSummary> GetViews(string owner, string name, RepositoryTrafficRequest per);
|
|
|
|
/// <summary>
|
|
/// Get the total number of views and breakdown per day or week for the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#views</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
/// <param name="per">Breakdown per day or week</param>
|
|
IObservable<RepositoryTrafficViewSummary> GetViews(long repositoryId, RepositoryTrafficRequest per);
|
|
|
|
/// <summary>
|
|
/// Get the total number of clones and breakdown per day or week for the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#clones</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="per">Breakdown per day or week</param>
|
|
IObservable<RepositoryTrafficCloneSummary> GetClones(string owner, string name, RepositoryTrafficRequest per);
|
|
|
|
/// <summary>
|
|
/// Get the total number of clones and breakdown per day or week for the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#clones</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
/// <param name="per">Breakdown per day or week</param>
|
|
IObservable<RepositoryTrafficCloneSummary> GetClones(long repositoryId, RepositoryTrafficRequest per);
|
|
}
|
|
}
|