mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-20 06:05:12 +00:00
64 lines
2.8 KiB
C#
64 lines
2.8 KiB
C#
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Repository Commits API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/repos/commits/">Repository Commits API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IRepositoryCommitsClient
|
|
{
|
|
/// <summary>
|
|
/// Compare two references in a repository
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name 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></returns>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")]
|
|
Task<CompareResult> Compare(string owner, string name, string @base, string head);
|
|
|
|
/// <summary>
|
|
/// Gets a single commit for a given repository
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="reference">The reference for the commit (SHA)</param>
|
|
/// <returns></returns>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
|
Justification = "Makes a network request")]
|
|
Task<GitHubCommit> Get(string owner, string name, string reference);
|
|
|
|
/// <summary>
|
|
/// Gets all commits for a given repository
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <returns></returns>
|
|
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all commits for a given repository
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="request">Used to filter list of commits returned</param>
|
|
/// <returns></returns>
|
|
Task<IReadOnlyList<GitHubCommit>> GetAll(string owner, string name, CommitRequest request);
|
|
|
|
/// <summary>
|
|
/// Get the SHA-1 of a commit reference
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="reference">The repository reference</param>
|
|
/// <returns></returns>
|
|
Task<string> GetSha1(string owner, string name, string reference);
|
|
}
|
|
}
|