module Octokit::Client::Search

Methods for the Search API

@see developer.github.com/v3/search/

Public Instance Methods

search_code(query, options = {}) click to toggle source

Search code

@param query [String] Search term and qualifiers @param options [Hash] Sort and pagination options @option options [String] :sort Sort field @option options [String] :order Sort order (asc or desc) @option options [Integer] :page Page of paginated results @option options [Integer] :per_page Number of items per page @return [Sawyer::Resource] Search results object @see 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 = {}) click to toggle source

Search commits

@param query [String] Search terms and qualifiers @param options [Hash] Sort and pagination options @option options [String] :sort Sort field @option options [String] :order Sort order (asc or desc) @option options [Integer] :page Page of paginated results @option options [Integer] :per_page Number of items per page @return [Sawyer::Resource] Search results object @see developer.github.com/v3/search/#search-commits

# File lib/octokit/client/search.rb, line 33
def search_commits(query, options = {})
  options = ensure_api_media_type(:commit_search, options)
  search "search/commits", query, options
end
search_issues(query, options = {}) click to toggle source

Search issues

@param query [String] Search term and qualifiers @param options [Hash] Sort and pagination options @option options [String] :sort Sort field @option options [String] :order Sort order (asc or desc) @option options [Integer] :page Page of paginated results @option options [Integer] :per_page Number of items per page @return [Sawyer::Resource] Search results object @see developer.github.com/v3/search/#search-issues-and-pull-requests

# File lib/octokit/client/search.rb, line 48
def search_issues(query, options = {})
  search "search/issues", query, options
end
search_repos(query, options = {})
Alias for: search_repositories
search_repositories(query, options = {}) click to toggle source

Search repositories

@param query [String] Search term and qualifiers @param options [Hash] Sort and pagination options @option options [String] :sort Sort field @option options [String] :order Sort order (asc or desc) @option options [Integer] :page Page of paginated results @option options [Integer] :per_page Number of items per page @return [Sawyer::Resource] Search results object @see 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
Also aliased as: search_repos
search_users(query, options = {}) click to toggle source

Search users

@param query [String] Search term and qualifiers @param options [Hash] Sort and pagination options @option options [String] :sort Sort field @option options [String] :order Sort order (asc or desc) @option options [Integer] :page Page of paginated results @option options [Integer] :per_page Number of items per page @return [Sawyer::Resource] Search results object @see developer.github.com/v3/search/#search-users

# File lib/octokit/client/search.rb, line 77
def search_users(query, options = {})
  search "search/users", query, options
end

Private Instance Methods