Description Usage Arguments Details Value See Also
This function allows users to access (GET) content from the GitHub API in a flexible way. The githubr
package provides convenience methods to access certain types of content - this function is provided to allow users to access any other API that they choose.
1 2 3 | githubRestGET(uri, endpoint = .getGithubCache("githubEndpoint"),
.opts = .getGithubCache("opts"),
httpheader = .getGithubCache("httpheader"), ...)
|
uri |
uri of the API request, e.g. "/repos/brian-bot/githubr" |
endpoint |
endpoint to access uri from, e.g. "https://api.github.com/" |
.opts |
additional options to be passed on to getURL |
httpheader |
httpheader to be passed onto getURL |
... |
other named parameters to be passed onto getURL |
Defaults to recieving content in JSON format (Accept="application/json"
) which is, in turn, converted into a list via the rjson
function fromJSON
. If authorization is set via setGithubToken
, the token specific to the githubr is used for subsequent calls to the API via this function.
Typically a list which is the content returned from the GitHub API and converted via fromJSON.
getPermlink
, githubRepo
, getRepo
, sourceRepoFile
, view
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.