mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-19 05:35:11 +00:00
[WIP] Add new Project API Preview (#1480)
Add Projects API client (preview)
This commit is contained in:
Martin Scholz
committed by
Ryan Gribble
Ryan Gribble
parent
fc5bc947aa
commit
329ef960ed
203
Octokit.Reactive/Clients/IObservableProjectsClient.cs
Normal file
203
Octokit.Reactive/Clients/IObservableProjectsClient.cs
Normal file
@@ -0,0 +1,203 @@
|
||||
using System;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
namespace Octokit.Reactive
|
||||
{
|
||||
/// <summary>
|
||||
/// A client for GitHub's Repository Projects API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/repos/projects/">Repository Projects API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
public interface IObservableProjectsClient
|
||||
{
|
||||
/// <summary>
|
||||
/// Get all projects for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
IObservable<Project> GetAllForRepository(string owner, string name);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <param name="request">Used to filter the list of projects returned</param>
|
||||
IObservable<Project> GetAllForRepository(string owner, string name, ProjectRequest request);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
IObservable<Project> GetAllForRepository(long repositoryId);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="request">Used to filter the list of projects returned</param>
|
||||
IObservable<Project> GetAllForRepository(long repositoryId, ProjectRequest request);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <param name="options">Options for changing the API response</param>
|
||||
IObservable<Project> GetAllForRepository(string owner, string name, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <param name="request">Used to filter the list of projects returned</param>
|
||||
/// <param name="options">Options for changing the API response</param>
|
||||
IObservable<Project> GetAllForRepository(string owner, string name, ProjectRequest request, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="options">Options for changing the API response</param>
|
||||
IObservable<Project> GetAllForRepository(long repositoryId, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-repository-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="request">Used to filter the list of projects returned</param>
|
||||
/// <param name="options">Options for changing the API response</param>
|
||||
IObservable<Project> GetAllForRepository(long repositoryId, ProjectRequest request, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified organization.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="organization">The name of the organziation</param>
|
||||
IObservable<Project> GetAllForOrganization(string organization);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified organization.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="organization">The name of the organziation</param>
|
||||
/// <param name="request">Used to filter the list of projects returned</param>
|
||||
IObservable<Project> GetAllForOrganization(string organization, ProjectRequest request);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified organization.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="organization">The name of the organziation</param>
|
||||
/// <param name="options">Options for changing the API response</param>
|
||||
IObservable<Project> GetAllForOrganization(string organization, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
/// Get all projects for the specified organization.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#list-organization-projects">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="organization">The name of the organziation</param>
|
||||
/// <param name="request">Used to filter the list of projects returned</param>
|
||||
/// <param name="options">Options for changing the API response</param>
|
||||
IObservable<Project> GetAllForOrganization(string organization, ProjectRequest request, ApiOptions options);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a single project for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/repos/projects/#get-a-project">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="id">The Id of the project</param>
|
||||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
|
||||
IObservable<Project> Get(int id);
|
||||
|
||||
/// <summary>
|
||||
/// Creates a project for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#create-a-repository-project">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="repositoryId">The Id of the repository</param>
|
||||
/// <param name="newProject">The new project to create for the specified repository</param>
|
||||
IObservable<Project> CreateForRepository(long repositoryId, NewProject newProject);
|
||||
|
||||
/// <summary>
|
||||
/// Creates a project for the specified organization.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/projects/#create-an-organization-project">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="organization">The name of the organization</param>
|
||||
/// <param name="newProject">The new project to create for the specified repository</param>
|
||||
IObservable<Project> CreateForOrganization(string organization, NewProject newProject);
|
||||
|
||||
/// <summary>
|
||||
/// Updates a project for the specified repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/repos/projects/#update-a-project">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="id">The Id of the project</param>
|
||||
/// <param name="projectUpdate">The modified project</param>
|
||||
IObservable<Project> Update(int id, ProjectUpdate projectUpdate);
|
||||
|
||||
/// <summary>
|
||||
/// Deletes a project.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/repos/projects/#delete-a-project">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="id">The Id of the project</param>
|
||||
IObservable<bool> Delete(int id);
|
||||
|
||||
/// <summary>
|
||||
/// A client for GitHub's Project Cards API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/repos/projects/cards/">Repository Projects API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
IObservableProjectCardsClient Card { get; }
|
||||
|
||||
/// <summary>
|
||||
/// A client for GitHub's Project Columns API.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="https://developer.github.com/v3/repos/projects/columns/">Repository Projects API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
IObservableProjectColumnsClient Column { get; }
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user