mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-05 11:40:42 +00:00
[FIX]: reworks all number parameter names to represent what they actually are. Refactors some types to be the appropriate types based on OpenAPI and docs. (#2948)
* reworks all number parameter names to represent what they actually are. Refactors some types to be the appropriate types based on OpenAPI and docs. * updates interfaces and implementations for id naming * updates reactive to match sync SDKs
This commit is contained in:
@@ -160,38 +160,38 @@ namespace Octokit.Reactive
|
||||
/// <summary>
|
||||
/// Retrives a single <see cref="Notification"/> by Id.
|
||||
/// </summary>
|
||||
/// <param name="id">The Id of the notification to retrieve.</param>
|
||||
/// <param name="notificationId">The Id of the notification to retrieve.</param>
|
||||
/// <remarks>http://developer.github.com/v3/activity/notifications/#view-a-single-thread</remarks>
|
||||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
|
||||
IObservable<Notification> Get(int id);
|
||||
IObservable<Notification> Get(int notificationId);
|
||||
|
||||
/// <summary>
|
||||
/// Marks a single notification as read.
|
||||
/// </summary>
|
||||
/// <param name="id">The id of the notification.</param>
|
||||
/// <param name="notificationId">The id of the notification.</param>
|
||||
/// <remarks>http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read</remarks>
|
||||
IObservable<Unit> MarkAsRead(int id);
|
||||
IObservable<Unit> MarkAsRead(int notificationId);
|
||||
|
||||
/// <summary>
|
||||
/// Retrives a <see cref="ThreadSubscription"/> for the provided thread id.
|
||||
/// </summary>
|
||||
/// <param name="id">The Id of the thread to retrieve subscription status.</param>
|
||||
/// <param name="threadId">The Id of the thread to retrieve subscription status.</param>
|
||||
/// <remarks>http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription</remarks>
|
||||
IObservable<ThreadSubscription> GetThreadSubscription(int id);
|
||||
IObservable<ThreadSubscription> GetThreadSubscription(int threadId);
|
||||
|
||||
/// <summary>
|
||||
/// Sets the authenticated user's subscription settings for a given thread.
|
||||
/// </summary>
|
||||
/// <param name="id">The Id of the thread to update.</param>
|
||||
/// <param name="threadId">The Id of the thread to update.</param>
|
||||
/// <param name="threadSubscription">The subscription parameters to set.</param>
|
||||
/// <remarks>http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription</remarks>
|
||||
IObservable<ThreadSubscription> SetThreadSubscription(int id, NewThreadSubscription threadSubscription);
|
||||
IObservable<ThreadSubscription> SetThreadSubscription(int threadId, NewThreadSubscription threadSubscription);
|
||||
|
||||
/// <summary>
|
||||
/// Deletes the authenticated user's subscription to a given thread.
|
||||
/// </summary>
|
||||
/// <param name="id">The Id of the thread to delete subscription from.</param>
|
||||
/// <param name="threadId">The Id of the thread to delete subscription from.</param>
|
||||
/// <remarks>http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription</remarks>
|
||||
IObservable<Unit> DeleteThreadSubscription(int id);
|
||||
IObservable<Unit> DeleteThreadSubscription(int threadId);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user