Module: Octokit::Client::Search

Included in:

Octokit::Client

Defined in:

lib/octokit/client/search.rb

Overview

Methods for the Search API

See Also:

• https://developer.github.com/v3/search/

Instance Method Summary

• #search_code(query, options = {}) ⇒ Sawyer::Resource

  Search code.

• #search_commits(query, options = {}) ⇒ Sawyer::Resource

  Search commits.

• #search_issues(query, options = {}) ⇒ Sawyer::Resource

  Search issues.

• #search_repositories(query, options = {}) ⇒ Sawyer::Resource (also: #search_repos)

  Search repositories.

• #search_topics(query, options = {}) ⇒ Sawyer::Resource

  Search topics.

• #search_users(query, options = {}) ⇒ Sawyer::Resource

  Search users.

Instance Method Details

#search_code(query, options = {}) ⇒ Sawyer::Resource

Search code

Parameters:

• query (String) —

  Search term and qualifiers

• options (Hash) (defaults to: {}) —

  Sort and pagination options

Options Hash (options):

• :sort (String) —

  Sort field

• :order (String) —

  Sort order (asc or desc)

• :page (Integer) —

  Page of paginated results

• :per_page (Integer) —

  Number of items per page

Returns:

• (Sawyer::Resource) —

  Search results object

See Also:

• https://developer.github.com/v3/search/#search-code

# File 'lib/octokit/client/search.rb', line 19

def search_code(query, options = {})
  search 'search/code', query, options
end

#search_commits(query, options = {}) ⇒ Sawyer::Resource

Search commits

Parameters:

• query (String) —

  Search terms and qualifiers

• options (Hash) (defaults to: {}) —

  Sort and pagination options

Options Hash (options):

• :sort (String) —

  Sort field

• :order (String) —

  Sort order (asc or desc)

• :page (Integer) —

  Page of paginated results

• :per_page (Integer) —

  Number of items per page

Returns:

• (Sawyer::Resource) —

  Search results object

See Also:

• https://developer.github.com/v3/search/#search-commits

# File 'lib/octokit/client/search.rb', line 33

def search_commits(query, options = {})
  search 'search/commits', query, options
end

#search_issues(query, options = {}) ⇒ Sawyer::Resource

Search issues

Parameters:

• query (String) —

  Search term and qualifiers

• options (Hash) (defaults to: {}) —

  Sort and pagination options

Options Hash (options):

• :sort (String) —

  Sort field

• :order (String) —

  Sort order (asc or desc)

• :page (Integer) —

  Page of paginated results

• :per_page (Integer) —

  Number of items per page

Returns:

• (Sawyer::Resource) —

  Search results object

See Also:

• https://developer.github.com/v3/search/#search-issues-and-pull-requests
• https://docs.github.com/en/rest/search#limitations-on-query-length

# File 'lib/octokit/client/search.rb', line 48

def search_issues(query, options = {})
  search 'search/issues', query, options
end

#search_repositories(query, options = {}) ⇒ Sawyer::Resource Also known as: search_repos

Search repositories

Parameters:

• query (String) —

  Search term and qualifiers

• options (Hash) (defaults to: {}) —

  Sort and pagination options

Options Hash (options):

• :sort (String) —

  Sort field

• :order (String) —

  Sort order (asc or desc)

• :page (Integer) —

  Page of paginated results

• :per_page (Integer) —

  Number of items per page

Returns:

• (Sawyer::Resource) —

  Search results object

See Also:

• https://developer.github.com/v3/search/#search-repositories

# File 'lib/octokit/client/search.rb', line 62

def search_repositories(query, options = {})
  search 'search/repositories', query, options
end

#search_topics(query, options = {}) ⇒ Sawyer::Resource

Search topics

Parameters:

• query (String) —

  Search term and qualifiers

• options (Hash) (defaults to: {}) —

  Sort and pagination options

Options Hash (options):

• :sort (String) —

  Sort field

• :order (String) —

  Sort order (asc or desc)

• :page (Integer) —

  Page of paginated results

• :per_page (Integer) —

  Number of items per page

Returns:

• (Sawyer::Resource) —

  Search results object

See Also:

• https://developer.github.com/v3/search/#search-topics

# File 'lib/octokit/client/search.rb', line 77

def search_topics(query, options = {})
  search 'search/topics', query, options
end

#search_users(query, options = {}) ⇒ Sawyer::Resource

Search users

Parameters:

• query (String) —

  Search term and qualifiers

• options (Hash) (defaults to: {}) —

  Sort and pagination options

Options Hash (options):

• :sort (String) —

  Sort field

• :order (String) —

  Sort order (asc or desc)

• :page (Integer) —

  Page of paginated results

• :per_page (Integer) —

  Number of items per page

Returns:

• (Sawyer::Resource) —

  Search results object

See Also:

• https://developer.github.com/v3/search/#search-users

# File 'lib/octokit/client/search.rb', line 91

def search_users(query, options = {})
  search 'search/users', query, options
end