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

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

Gets information about a specific license. For more information, see "Licensing a repository ."

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

Lists the most commonly used licenses on GitHub. For more information, see "Licensing a repository ."

options

Options

  • featured
  • per_page: The number of results per page (max 100).
  • page: 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

This method returns the contents of the repository's license file, if one is detected.

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

resources

Resources