View Source GitHub.Licenses (GitHub REST API Client v0.0.9)

Provides API endpoints related to licenses

Link to this section Summary

Functions

Get a license

Get all commonly used licenses

Get the license for a repository

Link to this section Functions

Link to this function

get(license, opts \\ [])

View Source
@spec get(
  String.t(),
  keyword()
) :: {:ok, GitHub.License.t()} | {:error, GitHub.Error.t()}

Get a license

resources

Resources

Link to this function

get_all_commonly_used(opts \\ [])

View Source
@spec get_all_commonly_used(keyword()) ::
  {:ok, [GitHub.License.simple()]} | {:error, GitHub.Error.t()}

Get all commonly used licenses

options

Options

  • featured (boolean):
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

get_for_repo(owner, repo, opts \\ [])

View Source
@spec get_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.License.Content.t()} | {:error, GitHub.Error.t()}

Get the license for a repository

resources

Resources