module Octokit::Client::Search
Methods for the Search
API
Public Instance Methods
Source
# File lib/octokit/client/search.rb, line 19 def search_code(query, options = {}) search 'search/code', query, options end
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
Source
# File lib/octokit/client/search.rb, line 33 def search_commits(query, options = {}) search 'search/commits', query, options end
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
Source
# File lib/octokit/client/search.rb, line 48 def search_issues(query, options = {}) search 'search/issues', query, options end
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 @see docs.github.com/en/rest/search#limitations-on-query-length
Source
# File lib/octokit/client/search.rb, line 62 def search_repositories(query, options = {}) search 'search/repositories', query, options end
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
Source
# File lib/octokit/client/search.rb, line 77 def search_topics(query, options = {}) search 'search/topics', query, options end
Search
topics
@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-topics
Source
# File lib/octokit/client/search.rb, line 91 def search_users(query, options = {}) search 'search/users', query, options end
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
Private Instance Methods
Source
# File lib/octokit/client/search.rb, line 97 def search(path, query, options = {}) opts = options.merge(q: query) paginate(path, opts) do |data, last_response| data.items.concat last_response.data.items end end