Parent

Included Modules

Class/Module Index [+]

Quicksearch

Github::Client::Search

The Search API is optimized to help you find the specific item you’re looking for (e.g., a specific user, a specific file in a repository, etc.).

Public Instance Methods

code(*args) click to toggle source

Find file contents via various criteria. (This method returns up to 100 results per page.)

@param [Hash] params @option params [String] :q

The search terms. This can be any combination of the supported
issue search parameters.

@option params [String] :sort

Optional sort field. One of comments, created, or updated.
If not provided, results are sorted by  best match.

@option params [String] :order

The sort order if sort parameter is provided.
One of asc or desc. Default: desc

@example

github = Github.new
github.search.code q: 'wycats'

@api public

# File lib/github_api/client/search.rb, line 122
def code(*args)
  params = arguments(args, required: [:q]).params
  params['q'] ||= arguments.q

  get_request('/search/code', params)
end
issues(*args) click to toggle source

Search issues

Find issues by state and keyword. (This method returns up to 100 results per page.)

@param [Hash] params @option params [String] :q

The search terms. This can be any combination of the supported
issue search parameters.

@option params [String] :sort

Optional sort field. One of comments, created, or updated.
If not provided, results are sorted by  best match.

@option params [String] :order

The sort order if sort parameter is provided.
One of asc or desc. Default: desc

@example

github = Github.new
github.search.issues 'query'

@example

github.search.issues q: 'query'

@api public

# File lib/github_api/client/search.rb, line 38
def issues(*args)
  params = arguments(args, required: [:q]).params
  params['q']      ||= arguments.q

  get_request('/search/issues' , params)
end
repos(*args) click to toggle source

Search repositories

Find repositories via various criteria. (This method returns up to 100 results per page.)

@param [Hash] params @option params [String] :q

The search keywords, as well as any qualifiers.

@option params [String] :sort

The sort field. One of stars, forks, or updated.
Default: results are sorted by best match.

@option params [String] :order

The sort order if sort parameter is provided.
One of asc or desc. Default: desc

@example

github = Github.new
github.search.repos 'query'

@example

github.search.repos q: 'query'

@api public

# File lib/github_api/client/search.rb, line 68
def repos(*args)
  params = arguments(args, required: [:q]).params
  params['q'] ||= arguments.q

  get_request('/search/repositories', arguments.params)
end
Also aliased as: repositories
repositories(*args) click to toggle source
Alias for: repos
users(*args) click to toggle source

Search users

Find users by keyword.

@param [Hash] params @option params [String] :q

The search terms. This can be any combination of the supported
issue search parameters.

@option params [String] :sort

Optional sort field. One of comments, created, or updated.
If not provided, results are sorted by  best match.

@option params [String] :order

The sort order if sort parameter is provided.
One of asc or desc. Default: desc

@example

github = Github.new
github.search.users q: 'wycats'

@api public

# File lib/github_api/client/search.rb, line 96
def users(*args)
  params = arguments(args, required: [:q]).params
  params['q'] ||= arguments.q

  get_request('/search/users', arguments.params)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.