mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
6bb0408582
* 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
190 lines
11 KiB
C#
190 lines
11 KiB
C#
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Pull Request Review API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/pulls/reviews/">Review API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IPullRequestReviewsClient
|
|
{
|
|
/// <summary>
|
|
/// Gets reviews for a specified pull request.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
Task<IReadOnlyList<PullRequestReview>> GetAll(string owner, string name, int pullRequestNumber);
|
|
|
|
/// <summary>
|
|
/// Gets reviews for a specified pull request.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
Task<IReadOnlyList<PullRequestReview>> GetAll(long repositoryId, int pullRequestNumber);
|
|
|
|
/// <summary>
|
|
/// Gets reviews for a specified pull request.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<PullRequestReview>> GetAll(string owner, string name, int pullRequestNumber, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets reviews for a specified pull request.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<PullRequestReview>> GetAll(long repositoryId, int pullRequestNumber, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets a single pull request review by ID.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#get-a-single-review</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
Task<PullRequestReview> Get(string owner, string name, int pullRequestNumber, long reviewId);
|
|
|
|
/// <summary>
|
|
/// Gets a single pull request review by ID.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#get-a-single-review</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
Task<PullRequestReview> Get(long repositoryId, int pullRequestNumber, long reviewId);
|
|
|
|
/// <summary>
|
|
/// Creates a pull request review.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="review">The review</param>
|
|
Task<PullRequestReview> Create(string owner, string name, int pullRequestNumber, PullRequestReviewCreate review);
|
|
|
|
/// <summary>
|
|
/// Creates a pull request review.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="review">The review</param>
|
|
Task<PullRequestReview> Create(long repositoryId, int pullRequestNumber, PullRequestReviewCreate review);
|
|
|
|
/// <summary>
|
|
/// Deletes a pull request review.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
Task Delete(string owner, string name, int pullRequestNumber, long reviewId);
|
|
|
|
/// <summary>
|
|
/// Deletes a pull request review.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
Task Delete(long repositoryId, int pullRequestNumber, long reviewId);
|
|
|
|
/// <summary>
|
|
/// Submits a pull request review.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
/// <param name="submitMessage">The message and event being submitted for the review</param>
|
|
Task<PullRequestReview> Submit(string owner, string name, int pullRequestNumber, long reviewId, PullRequestReviewSubmit submitMessage);
|
|
|
|
/// <summary>
|
|
/// Submits a pull request review.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
/// <param name="submitMessage">The message and event being submitted for the review</param>
|
|
Task<PullRequestReview> Submit(long repositoryId, int pullRequestNumber, long reviewId, PullRequestReviewSubmit submitMessage);
|
|
|
|
/// <summary>
|
|
/// Dismisses a pull request review.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
/// <param name="dismissMessage">The message indicating why the review was dismissed</param>
|
|
Task<PullRequestReview> Dismiss(string owner, string name, int pullRequestNumber, long reviewId, PullRequestReviewDismiss dismissMessage);
|
|
|
|
/// <summary>
|
|
/// Dismisses a pull request review.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
/// <param name="dismissMessage">The message indicating why the review was dismissed</param>
|
|
Task<PullRequestReview> Dismiss(long repositoryId, int pullRequestNumber, long reviewId, PullRequestReviewDismiss dismissMessage);
|
|
|
|
/// <summary>
|
|
/// Lists comments for a single review
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
Task<IReadOnlyList<PullRequestReviewComment>> GetAllComments(string owner, string name, int pullRequestNumber, long reviewId);
|
|
|
|
/// <summary>
|
|
/// Lists comments for a single review
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
Task<IReadOnlyList<PullRequestReviewComment>> GetAllComments(long repositoryId, int pullRequestNumber, long reviewId);
|
|
|
|
/// <summary>
|
|
/// Lists comments for a single review
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<PullRequestReviewComment>> GetAllComments(string owner, string name, int pullRequestNumber, long reviewId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Lists comments for a single review
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="pullRequestNumber">The pull request number</param>
|
|
/// <param name="reviewId">The pull request review number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<PullRequestReviewComment>> GetAllComments(long repositoryId, int pullRequestNumber, long reviewId, ApiOptions options);
|
|
}
|
|
}
|