Module: Octokit::EnterpriseAdminClient::SearchIndexing

Included in:
Octokit::EnterpriseAdminClient
Defined in:
lib/octokit/enterprise_admin_client/search_indexing.rb

Overview

Methods for the Enterprise Search Indexing API

See Also:

Instance Method Summary collapse

Instance Method Details

#index_repository(repo) ⇒ Sawyer:Resource

Queue a Repository to be indexed

Parameters:

  • repo (String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Sawyer:Resource) —

    Result of the queuing containing ‘:message`



22
23
24
 
# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 22

def index_repository(repo)
  queue_index Repository.new repo
end

#index_repository_code(repo) ⇒ Sawyer:Resource

Queue a repository’s code to be indexed

Parameters:

  • repo (String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Sawyer:Resource) —

    Result of the queuing containing ‘:message`



38
39
40
 
# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 38

def index_repository_code(repo)
  queue_index "#{Repository.new repo}/code"
end

#index_repository_issues(repo) ⇒ Sawyer:Resource

Queue a repository’s Issues to be indexed

Parameters:

  • repo (String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Sawyer:Resource) —

    Result of the queuing containing ‘:message`



30
31
32
 
# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 30

def index_repository_issues(repo)
  queue_index "#{Repository.new repo}/issues"
end

#index_user(user) ⇒ Sawyer:Resource Also known as: index_organization

Queue a User or Organization to be indexed

Parameters:

  • user (String) —

    A GitHub Enterprise user or organization

Returns:

  • (Sawyer:Resource) —

    Result of the queuing containing ‘:message`



13
14
15
 
# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 13

def index_user(user)
  queue_index user
end

#index_users_repositories(user) ⇒ Sawyer:Resource Also known as: index_organizations_repositories

Queue a user’s or organization’s repositories to be indexed

Parameters:

  • user (String) —

    A GitHub Enterprise user or organization

Returns:

  • (Sawyer:Resource) —

    Result of the queuing containing ‘:message`



46
47
48
 
# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 46

def index_users_repositories(user)
  queue_index "#{user}/*"
end

#index_users_repositories_code(user) ⇒ Sawyer:Resource Also known as: index_organizations_repositories_code

Queue an index of all the code contained in all of a user’s or organization’s repositories

Parameters:

  • user (String) —

    A GitHub Enterprise user or organization

Returns:

  • (Sawyer:Resource) —

    Result of the queuing containing ‘:message`



66
67
68
 
# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 66

def index_users_repositories_code(user)
  queue_index "#{user}/*/code"
end

#index_users_repositories_issues(user) ⇒ Sawyer:Resource Also known as: index_organizations_repositories_issues

Queue an index of all the issues across all of a user’s or organization’s repositories

Parameters:

  • user (String) —

    A GitHub Enterprise user or organization

Returns:

  • (Sawyer:Resource) —

    Result of the queuing containing ‘:message`



56
57
58
 
# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 56

def index_users_repositories_issues(user)
  queue_index "#{user}/*/issues"
end