mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-20 22:25:12 +00:00
86 lines
3.9 KiB
C#
86 lines
3.9 KiB
C#
using System;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Repository Deployments API.
|
|
/// Gets and creates Deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/repos/deployments/">Repository Deployments API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IObservableDeploymentsClient
|
|
{
|
|
/// <summary>
|
|
/// Gets all the deployments for the specified repository. Any user with pull access
|
|
/// to a repository can view deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#list-deployments
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
IObservable<Deployment> GetAll(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all the deployments for the specified repository. Any user with pull access
|
|
/// to a repository can view deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#list-deployments
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
IObservable<Deployment> GetAll(int repositoryId);
|
|
|
|
/// <summary>
|
|
/// Gets all the deployments for the specified repository. Any user with pull access
|
|
/// to a repository can view deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#list-deployments
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<Deployment> GetAll(string owner, string name, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the deployments for the specified repository. Any user with pull access
|
|
/// to a repository can view deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#list-deployments
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<Deployment> GetAll(int repositoryId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Creates a new deployment for the specified repository.
|
|
/// Users with push access can create a deployment for a given ref.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#create-a-deployment
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="newDeployment">A <see cref="NewDeployment"/> instance describing the new deployment to create</param>
|
|
IObservable<Deployment> Create(string owner, string name, NewDeployment newDeployment);
|
|
|
|
/// <summary>
|
|
/// Creates a new deployment for the specified repository.
|
|
/// Users with push access can create a deployment for a given ref.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#create-a-deployment
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="newDeployment">A <see cref="NewDeployment"/> instance describing the new deployment to create</param>
|
|
IObservable<Deployment> Create(int repositoryId, NewDeployment newDeployment);
|
|
|
|
/// <summary>
|
|
/// Client for managing deployment status.
|
|
/// </summary>
|
|
IObservableDeploymentStatusClient Status { get; }
|
|
}
|
|
} |