mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-06 12:03:19 +00:00
Ryan Gribble
3c818934b8
* Add release notes and bump version to 0.24 * run "build FormatCode" to fix up whitespace/formatting issues * Fix failing Ssh key tests due to "validation exception". This key must be in use on github (under another user, most likely from these tests failing). Changed to a new SSH key and tweaked tests to reduce chance of a key being created and not destroyed * Assignee and Assignees cant both be specified on NewIssue. We missed this one in the PR. Marked Assignee as [Obsolete] and fixed tests to use Assignees * Fix a couple of Reactions tests that were calling the wrong client methods * Fix timeline tests - looks like the response class has changed shape a bit, it now has an Issue object in the payload and Id field isnt present (leaving Id field there in case other timeline events do use it) * Fix some following tests that require the test user to follow more than 1 other user * Unskip these Event tests now because apparently they work! * add breaking changes notes * Update ApiErrorMessageSafe to return null for empty and whitespace strings (#1540) * return null if ApiError.Message is empty or whitespace * Uncomment test, which now passes * update release notes to include PR1540 * Add "Bot" AccountType, was causing a deserialization exception when running the integration test "SearchForExcludedLanguage" (#1541) * Update to include PR1541 * add bullets to make release notes easier to read * markup additional code mentions in notes * Fix grammar fields => field
197 lines
9.6 KiB
C#
197 lines
9.6 KiB
C#
using System;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Reactive;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Issue Milestones API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/milestones/">Issue Milestones API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IObservableMilestonesClient
|
|
{
|
|
/// <summary>
|
|
/// Gets a single Milestone by number.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#get-a-single-milestone
|
|
/// </remarks>
|
|
/// <returns></returns>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
|
Justification = "Method makes a network request")]
|
|
IObservable<Milestone> Get(string owner, string name, int number);
|
|
|
|
/// <summary>
|
|
/// Gets a single Milestone by number.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#get-a-single-milestone
|
|
/// </remarks>
|
|
/// <returns></returns>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
|
Justification = "Method makes a network request")]
|
|
IObservable<Milestone> Get(long repositoryId, int number);
|
|
|
|
/// <summary>
|
|
/// Gets all open milestones for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> GetAllForRepository(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all open milestones for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> GetAllForRepository(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Gets all open milestones for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
/// </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>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> GetAllForRepository(string owner, string name, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all open milestones for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> GetAllForRepository(long repositoryId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all open milestones for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="request">Used to filter and sort the list of Milestones returned</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> GetAllForRepository(string owner, string name, MilestoneRequest request);
|
|
|
|
/// <summary>
|
|
/// Gets all open milestones for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="request">Used to filter and sort the list of Milestones returned</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> GetAllForRepository(long repositoryId, MilestoneRequest request);
|
|
|
|
/// <summary>
|
|
/// Gets all open milestones for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="request">Used to filter and sort the list of Milestones returned</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> GetAllForRepository(string owner, string name, MilestoneRequest request, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all open milestones for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="request">Used to filter and sort the list of Milestones returned</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> GetAllForRepository(long repositoryId, MilestoneRequest request, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Creates a milestone for the specified repository. Any user with pull access to a repository can create a
|
|
/// Milestone.
|
|
/// </summary>
|
|
/// <remarks>http://developer.github.com/v3/issues/milestones/#create-a-milestone</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="newMilestone">A <see cref="NewMilestone"/> instance describing the new Milestone to create</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> Create(string owner, string name, NewMilestone newMilestone);
|
|
|
|
/// <summary>
|
|
/// Creates a milestone for the specified repository. Any user with pull access to a repository can create a
|
|
/// Milestone.
|
|
/// </summary>
|
|
/// <remarks>http://developer.github.com/v3/issues/milestones/#create-a-milestone</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="newMilestone">A <see cref="NewMilestone"/> instance describing the new Milestone to create</param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> Create(long repositoryId, NewMilestone newMilestone);
|
|
|
|
/// <summary>
|
|
/// Updates a milestone for the specified repository. Any user with pull access to a repository can create a
|
|
/// Milestone.
|
|
/// </summary>
|
|
/// <remarks>http://developer.github.com/v3/issues/milestones/#update-a-milestone</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The Milestone number</param>
|
|
/// <param name="milestoneUpdate">An <see cref="MilestoneUpdate"/> instance describing the changes to make to the Milestone
|
|
/// </param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> Update(string owner, string name, int number, MilestoneUpdate milestoneUpdate);
|
|
|
|
/// <summary>
|
|
/// Updates a milestone for the specified repository. Any user with pull access to a repository can create a
|
|
/// Milestone.
|
|
/// </summary>
|
|
/// <remarks>http://developer.github.com/v3/issues/milestones/#update-a-milestone</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="number">The Milestone number</param>
|
|
/// <param name="milestoneUpdate">An <see cref="MilestoneUpdate"/> instance describing the changes to make to the Milestone
|
|
/// </param>
|
|
/// <returns></returns>
|
|
IObservable<Milestone> Update(long repositoryId, int number, MilestoneUpdate milestoneUpdate);
|
|
|
|
/// <summary>
|
|
/// Deletes a milestone for the specified repository. Any user with pull access to a repository can create an
|
|
/// Milestone.
|
|
/// </summary>
|
|
/// <remarks>http://developer.github.com/v3/issues/milestones/#delete-a-milestone</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The milestone number</param>
|
|
/// <returns></returns>
|
|
IObservable<Unit> Delete(string owner, string name, int number);
|
|
|
|
/// <summary>
|
|
/// Deletes a milestone for the specified repository. Any user with pull access to a repository can create an
|
|
/// Milestone.
|
|
/// </summary>
|
|
/// <remarks>http://developer.github.com/v3/issues/milestones/#delete-a-milestone</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="number">The milestone number</param>
|
|
/// <returns></returns>
|
|
IObservable<Unit> Delete(long repositoryId, int number);
|
|
}
|
|
}
|