Question: how to get closed issues from the get_issue function about projmgr HOT 3 CLOSED

I spend sometimes to GitHub API.
Maybe the reason is the default state for the issue API is open?

curl -H "Authorization: token {private_token}" https://api.github.com/repos/JiaxiangBU/tutoring/issues?state=open -s
curl -H "Authorization: token {private_token}" https://api.github.com/repos/JiaxiangBU/tutoring/issues?state=closed -s

from projmgr.

Hi @JiaxiangBU - that's right! I didn't override any of the API's defaults for a consistent experience for anyone accessing the GitHub API through multiple tools.

To get closed issues, you can pass any of the API query parameters through the ...s in the get_ functions. For example, in this case, we can do:

library(projmgr)
library(magrittr)
repo <- create_repo_ref("JiaxiangBU", "tutoring")
#> Requests will authenticate with GITHUB_PAT
issue_list <- get_issues(repo, state = "all") %>% parse_issues()
nrow(issue_list)
#> [1] 61

To know what query parameters are available, you can also use the help_{function name} family of functions for the names of the query parameters for each endpoint. For example:

help_get_issues()
#> [1] "milestone" "state"     "assignee"  "creator"   "mentioned" "labels"    "sort"      "direction" "since"  

And for more details what each of these means, you can use the browse_docs family to open up the correct page of GitHub API documentation. For example, browse_docs(action = "get", object= "issue") should open this

Please let me know if that answers the question, and thanks for filing the issue! I will think about how I can highlight this better in the documentation.

from projmgr.

@emilyriederer thanks for your reply, I think it works for me with your reproducible example.

reproducible example works

library(projmgr)
library(magrittr)
repo <- create_repo_ref("JiaxiangBU", "tutoring")
#> Requests will authenticate with GITHUB_PAT
issue_list <- get_issues(repo, state = "all") %>% parse_issues()
nrow(issue_list)
#> [1] 61

^{Created on 2019-07-07 by the reprex package (v0.2.1)}

further information is helpful

And for more details what each of these means, you can use the browse_docs family to open up the correct page of GitHub API documentation. For example, browse_docs(action = "get", object= "issue") should open this

projmgr::help_get_issues()
#> [1] "milestone" "state"     "assignee"  "creator"   "mentioned" "labels"   
#> [7] "sort"      "direction" "since"

^{Created on 2019-07-07 by the reprex package (v0.2.1)}

projmgr::browse_docs(action = "get", object = "issue")
#> Open URL https://developer.github.com/v3/issues/#list-issues-for-a-repository

^{Created on 2019-07-07 by the reprex package (v0.2.1)}

I see the arg description at this URL.

good to beginners

Please let me know if that answers the question, and thanks for filing the issue! I will think about how I can highlight this better in the documentation.

I agree with you, maybe other beginners of this package face a similar question.

Thanks a lot.

from projmgr.