gh_url: Build the URL for the GitHub API

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

This function is used to build the URL for the various endpoints in the GitHub API. Unnamed strings are used to build the path upon the API and named strings are added as queries.

Usage

gh_url(..., api = getOption("github.api"))

Arguments

...	(strings, optional) unnamed strings are built up into a URL path and named parameters are added as queries.
api	(string, optional) The URL of GitHub's API. Default: the value stored in the environment variable GITHUB_API_URL or https://api.github.com.

Value

Valid URL (string)

Examples

## Not run: 

  # URL for all repositories
  gh_url("repos")

  # URL for the main branch
  gh_url("repos", "ChadGoymer/githapi", "git/refs/heads", "main")

  # URL for a file tree with the recursive option
  gh_url(
    c("repos", "ChadGoymer/githapi", "git/trees", "234752384"),
    list(recursive = 1)
  )


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.