Module: Octokit::Client::Licenses
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Defined in: | lib/octokit/client/licenses.rb |
Overview
Methods for licenses API
Instance Method Summary
-
#license(license_name, options = {}) ⇒ Sawyer::Resource
List an individual license.
-
#licenses(options = {}) ⇒ Array<Sawyer::Resource>
List all licenses.
-
#repository_license_contents(repo, options = {}) ⇒ Sawyer::Resource
Returns the contents of the repository’s license file, if one is detected.
Instance Method Details
#license(license_name, options = {}) ⇒ Sawyer::Resource
List an individual license
# File 'lib/octokit/client/licenses.rb', line 25
def license(license_name, = {}) get "licenses/#{license_name}", end
#licenses(options = {}) ⇒ Array
<Sawyer::Resource
>
List all licenses
# File 'lib/octokit/client/licenses.rb', line 14
def licenses( = {}) paginate 'licenses', end
#repository_license_contents(repo, options = {}) ⇒ Sawyer::Resource
Returns the contents of the repository’s license file, if one is detected.
# File 'lib/octokit/client/licenses.rb', line 37
def repository_license_contents(repo, = {}) get "#{Repository.path repo}/license", end