Skip to content

Commit

Permalink
update note for Preview APIs in readme
Browse files Browse the repository at this point in the history
Now that the preview api accept headers are taken care of in the library
let the user know that it's mostly taken care of but leave example in
case an accept header needs to be manually added.
  • Loading branch information
Joe Gallo committed Oct 8, 2016
1 parent 2d67df5 commit 0c0228d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,8 @@ $ npm test test/issuesTest.js

## Preview APIs

Some APIs are in a preview period and require a custom `Accept` header.
See [examples/getReactionsForIssue.js](https://github.com/mikedeboer/node-github/blob/master/examples/getReactionsForIssue.js) for an example.
Accept headers for the preview APIs should be taken care of behind the scenes, but in the event a preview endpoint isn't working, see [here](https://github.com/mikedeboer/node-github/blob/master/examples/getReactionsForIssue.js) for an example on how to add the required custom accept header.

For updates on endpoints under preview, see https://developer.github.com/changes/.

| Preview API | Accept header val |
Expand Down

0 comments on commit 0c0228d

Please sign in to comment.