add documentation about pull request files

JuliaWeb · Oct 26, 2021 · 92c6aff · 92c6aff
1 parent 0950354
commit 92c6aff
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,7 @@ Here's a table that matches up the provided `GitHubType`s with their correspondi
 | `Label`      | name, e.g. `bug`                                              | [issue labels](https://docs.github.com/en/rest/reference/issues#labels)
 | `Status`      | id, e.g. `366961773`                                              | [commit statuses](https://developer.github.com/v3/repos/statuses/)                                                                                                                                            |
 | `PullRequest` | number, e.g. `44`                                                 | [pull requests](https://developer.github.com/v3/pulls/)                                                                                                                                                       |
+| `PullRequestFile` | filename, e.g. `file1.txt`                                                 | [pull request files](https://docs.github.com/en/rest/reference/pulls#list-pull-requests-files)                                                                                                                                                       |
 | `Issue`       | number, e.g. `31`                                                 | [issues](https://developer.github.com/v3/issues/)                                                                                                                                                             |
 | `Team`        | id, e.g. `1`                                                      | [teams](https://developer.github.com/v3/orgs/teams)                                                                                                                                                           |
 | `Gist`        | id, e.g. `0bace7cc774df4b3a4b0ee9aaa271ef6`                       | [gists](https://developer.github.com/v3/gists)                                                                                                                                                                |
@@ -137,6 +138,7 @@ GitHub.jl implements a bunch of methods that make REST requests to GitHub's API.
 |---------------------------------|------------------------------------|------------------------------------------------------------------------------------------------------------|
 | `pull_request(repo, pr)`        | `PullRequest`                      | [get the pull request specified by `pr`](https://developer.github.com/v3/pulls/#get-a-single-pull-request) |
 | `pull_requests(repo)`           | `Tuple{Vector{PullRequest}, Dict}` | [get `repo`'s pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)                    |
+| `pull_request_files(repo, pr)`           | `Tuple{Vector{PullRequestFiles}, Dict}` | [get this `repo`'s `pr`'s file changes](https://docs.github.com/en/rest/reference/pulls#list-pull-requests-files)                    |
 | `create_pull_request(repo)`     | `PullRequest`                      | [create pull request in `repo`](https://developer.github.com/v3/pulls/#create-a-pull-request)              |
 | `update_pull_request(repo, pr)` | `PullRequest`                      | [update the given `pr` in `repo`](https://developer.github.com/v3/pulls/#update-a-pull-request)            |
 | `close_pull_request(repo, pr)`  | `PullRequest`                      | [close the given `pr` in `repo`](https://developer.github.com/v3/pulls/#update-a-pull-request)             |