mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-18 05:05:14 +00:00
6565a07974
* Fixes ids for Releases, Collaborators, and Contributors * updates the interface for releases * update the obverable release client * updates ids from int to long based on GH database schema * converts a test condition to use the proper type * updates generated paging and observable classes
88 lines
4.3 KiB
C#
88 lines
4.3 KiB
C#
using System;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Repository Deployment Statuses API.
|
|
/// Gets and creates Deployment Statuses.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/repos/deployments/">Repository Deployment Statuses API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IObservableDeploymentStatusClient
|
|
{
|
|
/// <summary>
|
|
/// Gets all the statuses for the given deployment. Any user with pull access to a repository can
|
|
/// view deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#list-deployment-statuses
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository.</param>
|
|
/// <param name="name">The name of the repository.</param>
|
|
/// <param name="deploymentId">The id of the deployment.</param>
|
|
IObservable<DeploymentStatus> GetAll(string owner, string name, long deploymentId);
|
|
|
|
/// <summary>
|
|
/// Gets all the statuses for the given deployment. Any user with pull access to a repository can
|
|
/// view deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#list-deployment-statuses
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository.</param>
|
|
/// <param name="deploymentId">The id of the deployment.</param>
|
|
IObservable<DeploymentStatus> GetAll(long repositoryId, long deploymentId);
|
|
|
|
/// <summary>
|
|
/// Gets all the statuses for the given deployment. Any user with pull access to a repository can
|
|
/// view deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#list-deployment-statuses
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository.</param>
|
|
/// <param name="name">The name of the repository.</param>
|
|
/// <param name="deploymentId">The id of the deployment.</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<DeploymentStatus> GetAll(string owner, string name, long deploymentId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the statuses for the given deployment. Any user with pull access to a repository can
|
|
/// view deployments.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#list-deployment-statuses
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository.</param>
|
|
/// <param name="deploymentId">The id of the deployment.</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<DeploymentStatus> GetAll(long repositoryId, long deploymentId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Creates a new status for the given deployment. Users with push access can create deployment
|
|
/// statuses for a given deployment.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#create-a-deployment-status
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository.</param>
|
|
/// <param name="name">The name of the repository.</param>
|
|
/// <param name="deploymentId">The id of the deployment.</param>
|
|
/// <param name="newDeploymentStatus">The new deployment status to create.</param>
|
|
IObservable<DeploymentStatus> Create(string owner, string name, long deploymentId, NewDeploymentStatus newDeploymentStatus);
|
|
|
|
/// <summary>
|
|
/// Creates a new status for the given deployment. Users with push access can create deployment
|
|
/// statuses for a given deployment.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/repos/deployments/#create-a-deployment-status
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository.</param>
|
|
/// <param name="deploymentId">The id of the deployment.</param>
|
|
/// <param name="newDeploymentStatus">The new deployment status to create.</param>
|
|
IObservable<DeploymentStatus> Create(long repositoryId, long deploymentId, NewDeploymentStatus newDeploymentStatus);
|
|
}
|
|
}
|