Files
octokit.net/Octokit/Clients/ICommitStatusClient.cs
T
Peter MacNaughton 231fa2c520 API interface summaries
Modified existing comments in IGitDatabaseClient, IMiscellaneousClient and
ITeamsClient. Hopefully for valid reasons.
2013-12-02 22:08:21 -07:00

36 lines
1.6 KiB
C#

using System.Collections.Generic;
using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Git Repository Status API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/statuses/">Repository Statuses API documentation</a> for more information.
/// </remarks>
public interface ICommitStatusClient
{
/// <summary>
/// Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or
/// a tag name.
/// </summary>
/// <remarks>Only users with pull access can see this.</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The reference (SHA, branch name, or tag name) to list commits for</param>
/// <returns></returns>
Task<IReadOnlyList<CommitStatus>> GetAll(string owner, string name, string reference);
/// <summary>
/// Creates a commit status for the specified ref.
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The reference (SHA, branch name, or tag name) to list commits for</param>
/// <param name="commitStatus">The commit status to create</param>
/// <returns></returns>
Task<CommitStatus> Create(string owner, string name, string reference, NewCommitStatus commitStatus);
}
}