circle {circle} | R Documentation |
Circle CI HTTP Requests
Description
Workhorse function for executing API requests to Circle CI.
Usage
circle(
verb = "GET",
path = "",
query = list(),
body = "",
api_version = "v2",
encode = "json"
)
Arguments
verb |
|
path |
|
query |
|
body |
|
api_version |
|
encode |
|
Details
In almost all cases, users should not need to execute API calls directly. However, if desired this functions makes it possible to issue any API request. If you experience calling a custom request heavily, consider opening a feature request on GitHub.
Value
An object of class circle_api
with the following elements
-
content
(queried content) -
path
(API request) -
response
(HTTP response information)
Examples
## Not run:
circle(verb = "GET", path = "/project/gh/ropensci/circle/checkout-key")
## End(Not run)