Files
octokit.net/Octokit/Clients/BlobsClient.cs
2020-03-04 21:10:38 -04:00

93 lines
3.6 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 class BlobsClient : ApiClient, IBlobsClient
{
/// <summary>
/// Instantiates a new GitHub Git Blobs API client.
/// </summary>
/// <param name="apiConnection">An API connection</param>
public BlobsClient(IApiConnection apiConnection)
: base(apiConnection)
{
}
/// <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>
[ManualRoute("GET", "/repos/{owner}/{name}/git/blobs/{file_sha}")]
public Task<Blob> Get(string owner, string name, string reference)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
return ApiConnection.Get<Blob>(ApiUrls.Blob(owner, name, 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>
[ManualRoute("GET", "/repositories/{id}/git/blobs/{file_sha}")]
public Task<Blob> Get(long repositoryId, string reference)
{
Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
return ApiConnection.Get<Blob>(ApiUrls.Blob(repositoryId, 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>
[ManualRoute("POST", "/repos/{owner}/{name}/git/blobs")]
public Task<BlobReference> Create(string owner, string name, NewBlob newBlob)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(newBlob, nameof(newBlob));
return ApiConnection.Post<BlobReference>(ApiUrls.Blobs(owner, name), 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>
[ManualRoute("POST", "/repositories/{id}/git/blobs")]
public Task<BlobReference> Create(long repositoryId, NewBlob newBlob)
{
Ensure.ArgumentNotNull(newBlob, nameof(newBlob));
return ApiConnection.Post<BlobReference>(ApiUrls.Blobs(repositoryId), newBlob);
}
}
}