zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-04 19:26:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

added overloads on I(Observable)RepositoryCommitsClient

Browse Source
This commit is contained in:
aedampir@gmail.com
2016-06-06 14:16:44 +07:00
parent 04d3a2da95
commit 0cc37f861d
4 changed files with 301 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit/Clients/IRepositoryCommitsClient.cs
+60
View File
@@ -23,6 +23,16 @@ namespace Octokit
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")]
Task<CompareResult> Compare(string owner, string name, string @base, string head);
/// <summary>
/// Compare two references in a repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="base">The reference to use as the base commit</param>
/// <param name="head">The reference to use as the head commit</param>
/// <returns>A <see cref="CompareResult"/> for the specified references.</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")]
Task<CompareResult> Compare(int repositoryId, string @base, string head);
/// <summary>
/// Gets a single commit for a given repository
/// </summary>
@@ -34,6 +44,16 @@ namespace Octokit
Justification = "Makes a network request")]
Task<GitHubCommit> Get(string owner, string name, string reference);
/// <summary>
/// Gets a single commit for a given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="reference">The reference for the commit (SHA)</param>
/// <returns>A <see cref="GitHubCommit"/> for the specified commit SHA.</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Makes a network request")]
Task<GitHubCommit> Get(int repositoryId, string reference);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
@@ -42,6 +62,13 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
@@ -51,6 +78,14 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, ApiOptions options);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId, ApiOptions options);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
@@ -60,6 +95,14 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, CommitRequest request);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter list of commits returned</param>
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId, CommitRequest request);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
@@ -70,6 +113,15 @@ namespace Octokit
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, CommitRequest request, ApiOptions options);
/// <summary>
/// Gets all commits for a given repository
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">Used to filter list of commits returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A <see cref="IReadOnlyList{GitHubCommit}"/> of <see cref="GitHubCommit"/>s for the specified repository.</returns>
Task<IReadOnlyList<GitHubCommit>> GetAll(int repositoryId, CommitRequest request, ApiOptions options);
/// <summary>
/// Get the SHA-1 of a commit reference
/// </summary>
@@ -78,5 +130,13 @@ namespace Octokit
/// <param name="reference">The repository reference</param>
/// <returns>A <see cref="string"/> for the specified repository reference.</returns>
Task<string> GetSha1(string owner, string name, string reference);
/// <summary>
/// Get the SHA-1 of a commit reference
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="reference">The repository reference</param>
/// <returns>A <see cref="string"/> for the specified repository reference.</returns>
Task<string> GetSha1(int repositoryId, string reference);
}
}