mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-21 14:45:11 +00:00
84 lines
3.6 KiB
C#
84 lines
3.6 KiB
C#
using System;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Git Trees API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/git/trees/">Git Trees API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IObservableTreesClient
|
|
{
|
|
/// <summary>
|
|
/// Gets a Tree Response for a given SHA.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/git/trees/#get-a-tree
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="reference">The SHA that references the tree</param>
|
|
/// <returns></returns>
|
|
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
|
|
IObservable<TreeResponse> Get(string owner, string name, string reference);
|
|
|
|
/// <summary>
|
|
/// Gets a Tree Response for a given SHA.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/git/trees/#get-a-tree
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The ID of the repository</param>
|
|
/// <param name="reference">The SHA that references the tree</param>
|
|
/// <returns></returns>
|
|
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
|
|
IObservable<TreeResponse> Get(int repositoryId, string reference);
|
|
|
|
/// <summary>
|
|
/// Gets a Tree Response for a given SHA.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// https://developer.github.com/v3/git/trees/#get-a-tree-recursively
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="reference">The SHA that references the tree</param>
|
|
/// <returns></returns>
|
|
IObservable<TreeResponse> GetRecursive(string owner, string name, string reference);
|
|
|
|
/// <summary>
|
|
/// Gets a Tree Response for a given SHA.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// https://developer.github.com/v3/git/trees/#get-a-tree-recursively
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The ID of the repository</param>
|
|
/// <param name="reference">The SHA that references the tree</param>
|
|
/// <returns></returns>
|
|
IObservable<TreeResponse> GetRecursive(int repositoryId, string reference);
|
|
|
|
/// <summary>
|
|
/// Creates a new Tree in the specified repo
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/git/trees/#create-a-tree
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="newTree">The value of the new tree</param>
|
|
/// <returns></returns>
|
|
IObservable<TreeResponse> Create(string owner, string name, NewTree newTree);
|
|
|
|
/// <summary>
|
|
/// Creates a new Tree in the specified repo
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/git/trees/#create-a-tree
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The ID of the repository</param>
|
|
/// <param name="newTree">The value of the new tree</param>
|
|
/// <returns></returns>
|
|
IObservable<TreeResponse> Create(int repositoryId, NewTree newTree);
|
|
}
|
|
} |