added missing /repos/{owner}/{repo}/pulls/... handlers (#546) #605
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dmgorsky
changed the title
…_number}/reviews/{review_id})
…s/{pull_number}/reviews/{review_id}/events
dmgorsky
changed the title
XAMPPRocky
reviewed
Mar 19, 2024
src/api/pulls.rs
Outdated
Comment on lines
392
to
403
| /// creates a builder for the `/repos/{owner}/{repo}/pulls/{pull_number}/......` endpoint | ||
| /// working with particular pull request, e.g. | ||
| /// * /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events | ||
| /// * /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id} | ||
| /// * /repos/{owner}/{repo}/pulls/{pull_number}/commits | ||
| /// * /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments | ||
| /// * /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals | ||
| /// * /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies | ||
| /// | ||
| pub fn pull_number(&self, pull_nr: u64) -> SpecificPullRequestBuilder { | ||
| SpecificPullRequestBuilder::new(self, pull_nr) | ||
| } |
There was a problem hiding this comment.
I think instead of having a specific builder for this, we should instead mimic octokit here, and have each of these methods attached to the pulls builder, and have the pull number as a required argument.
There was a problem hiding this comment.
So far it is looking like
octocrab.pulls("owner", "repo")
.pull_number(42)
.reviews()
.review(42).get()
octocrab.pulls("owner", "repo")
.pull_number(42)
.reviews()
.review(42).update("this is a new body")
octocrab.pulls("owner", "repo")
.pull_number(42)
.comment(CommentId(42))
.reply("new comment")
octocrab.pulls("owner", "repo")
.pull_number(42)
.reviews().review(42)
.list_comments()
.per_page(10)
.page(3u32)
.send()How do you prefer it? Octokit does it like
[ManualRoute("GET", "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments")]
public Task<IReadOnlyList<PullRequestReviewComment>> GetAllComments(string owner, string name, int number, long reviewId, ApiOptions options)so we would have
-=1=-
octocrab.pulls("owner", "repo")
.get_all_comments(/*pr_nr*/ 42, /*review_nr*/ 42)
.per_page(10)
.page(3u32)
.send()or even
-=2=-
octocrab.pulls("owner", "repo")
.get_all_comments(/*pr_nr*/ 42, /*review_nr*/ 42, /*pagination*/ PagingOptions{...})?
IMHO, in absence of named arguments, the following options are more readable:
- Builder pattern;
- Struct parameter.
Anyways, I sense we go with -=1=- (to retain Octocrab pagination style)? TIA @XAMPPRocky
There was a problem hiding this comment.
Yes, 1, I just mean removing the pull_number builder and having the pr number as the first argument in these calls. Keeping the other builders.
There was a problem hiding this comment.
@XAMPPRocky please check if it suits: 377342b
crazywolf132
approved these changes
May 19, 2024
|
Thank you for your PR! |
Merged
Comment on lines
+425
to
+428
| /// /repos/{owner}/{repo}/pulls/{pull_number}/commits | ||
| // pub fn pr_commits(&self, pull_nr: u64) -> SpecificPullRequestCommentBuilder<'octo, '_> { | ||
| // SpecificPullRequestCommentBuilder::new(self, pull_nr, 0) | ||
| // } |
There was a problem hiding this comment.
please take a look at #680
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
solves #546