kylefang/probot
1
0
Fork 0
mirror of https://github.com/zhigang1992/probot.git synced 2026-06-16 02:44:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update node-github => octokit/rest.js in docs (#445)

Browse Source
This commit is contained in:
Brandon Keepers
2018-02-28 09:29:47 -06:00
committed by GitHub
parent 0060098fd7
commit ce4727596f
3 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/github-api.md
View File

@@ -6,7 +6,7 @@ next: docs/http.md
Probot uses [GitHub Apps](https://developer.github.com/apps/). An app is a first-class actor on GitHub, like a user (e.g. [@defunkt](https://github.com/defunkt)) or an organization (e.g. [@github](https://github.com/github)). The app is given access to a repository or repositories by being "installed" on a user or organization account and can perform actions through the API like [commenting on an issue](https://developer.github.com/v3/issues/comments/#create-a-comment) or [creating a status](https://developer.github.com/v3/repos/statuses/#create-a-status).
`context.github` is an authenticated GitHub client that can be used to make API calls. It is an instance of the [github Node.js module](https://github.com/octokit/node-github), which wraps the [GitHub REST API](https://developer.github.com/v3/) and allows you to do almost anything programmatically that you can do through a web browser.
`context.github` is an authenticated GitHub client that can be used to make API calls. It is an instance of the [`@octokit/rest` Node.js module](https://github.com/octokit/rest.js), which wraps the [GitHub REST API](https://developer.github.com/v3/) and allows you to do almost anything programmatically that you can do through a web browser.
Here is an example of an autoresponder app that comments on opened issues:
@@ -24,7 +24,7 @@ module.exports = robot => {
}
```
See the [full API docs](https://octokit.github.io/node-github/) to see all the ways you can interact with GitHub. Some API endpoints are not available on GitHub Apps yet, so check [which ones are available](https://developer.github.com/v3/apps/available-endpoints/) first.
See the [full API docs](https://octokit.github.io/rest.js/) to see all the ways you can interact with GitHub. Some API endpoints are not available on GitHub Apps yet, so check [which ones are available](https://developer.github.com/v3/apps/available-endpoints/) first.
## GitHub Enterprise
@@ -35,4 +35,3 @@ GHE_HOST=fake.github-enterprise.com
```
> GitHub Apps are enabled in GitHub Enterprise 2.12 as an [early access technical preview](https://developer.github.com/enterprise/2.12/apps/).