Files
octokit.net/Octokit/Clients/IBlobsClient.cs
2016-09-15 02:15:11 +02:00

57 lines
2.3 KiB
C#

using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Git Blobs API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/git/blobs/">Git Blobs API documentation</a> for more information.
/// </remarks>
public interface IBlobsClient
{
/// <summary>
/// Gets a single Blob by SHA.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/git/blobs/#get-a-blob
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The SHA of the blob</param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
Task<Blob> Get(string owner, string name, string reference);
/// <summary>
/// Gets a single Blob by SHA.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/git/blobs/#get-a-blob
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The SHA of the blob</param>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
Task<Blob> Get(long repositoryId, string reference);
/// <summary>
/// Creates a new Blob
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/git/blobs/#create-a-blob
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newBlob">The new Blob</param>
Task<BlobReference> Create(string owner, string name, NewBlob newBlob);
/// <summary>
/// Creates a new Blob
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/git/blobs/#create-a-blob
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="newBlob">The new Blob</param>
Task<BlobReference> Create(long repositoryId, NewBlob newBlob);
}
}