Module: BacklogKit::Client::Wiki

Included in:
BacklogKit::Client
Defined in:
lib/backlog_kit/client/wiki.rb

Overview

Methods for the Wiki API

Instance Method Summary collapse

Instance Method Details

#create_wiki(name, content, project_id, params = {}) ⇒ BacklogKit::Response

Create a new wiki page

Parameters:

  • name (String) —

    Name of the page

  • content (String) —

    Content of the page

  • project_id (Integer, String) —

    Project id

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

    Request parameters

Returns:



46
47
48
49
 
# File 'lib/backlog_kit/client/wiki.rb', line 46

def create_wiki(name, content, project_id, params = {})
  params.merge!(name: name, content: content, project_id: project_id)
  post('wikis', params)
end

#delete_wiki(wiki_id, params = {}) ⇒ BacklogKit::Response

Delete a wiki page

Parameters:

  • wiki_id (Integer, String) —

    Wiki page id

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

    Request parameters

Returns:



65
66
67
 
# File 'lib/backlog_kit/client/wiki.rb', line 65

def delete_wiki(wiki_id, params = {})
  delete("wikis/#{wiki_id}", params)
end

#get_wiki(wiki_id) ⇒ BacklogKit::Response

Get a wiki page

Parameters:

  • wiki_id (Integer, String) —

    Wiki page id

Returns:



27
28
29
 
# File 'lib/backlog_kit/client/wiki.rb', line 27

def get_wiki(wiki_id)
  get("wikis/#{wiki_id}")
end

#get_wiki_count(project_id_or_key) ⇒ BacklogKit::Response

Get number of wiki pages

Parameters:

  • project_id_or_key (Integer, String) —

    Project id or project key

Returns:



19
20
21
 
# File 'lib/backlog_kit/client/wiki.rb', line 19

def get_wiki_count(project_id_or_key)
  get('wikis/count', project_id_or_key: project_id_or_key)
end

#get_wiki_histories(wiki_id, params = {}) ⇒ BacklogKit::Response

Get list of wiki histories

Parameters:

  • wiki_id (Integer, String) —

    Wiki page id

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

    Request parameters

Returns:



100
101
102
 
# File 'lib/backlog_kit/client/wiki.rb', line 100

def get_wiki_histories(wiki_id, params = {})
  get("wikis/#{wiki_id}/history", params)
end

#get_wiki_shared_files(wiki_id) ⇒ BacklogKit::Response

Get list of shared files on wiki

Parameters:

  • wiki_id (Integer, String) —

    Wiki page id

Returns:



73
74
75
 
# File 'lib/backlog_kit/client/wiki.rb', line 73

def get_wiki_shared_files(wiki_id)
  get("wikis/#{wiki_id}/sharedFiles")
end

#get_wiki_stars(wiki_id) ⇒ BacklogKit::Response

Get list of wiki stars

Parameters:

  • wiki_id (Integer, String) —

    Wiki page id

Returns:



108
109
110
 
# File 'lib/backlog_kit/client/wiki.rb', line 108

def get_wiki_stars(wiki_id)
  get("wikis/#{wiki_id}/stars")
end

#get_wiki_tags(project_id_or_key) ⇒ BacklogKit::Response

Get list of wiki page tags

Parameters:

  • project_id_or_key (Integer, String) —

    Project id or project key

Returns:



35
36
37
 
# File 'lib/backlog_kit/client/wiki.rb', line 35

def get_wiki_tags(project_id_or_key)
  get('wikis/tags', project_id_or_key: project_id_or_key)
end

#get_wikis(project_id_or_key) ⇒ BacklogKit::Response

Get list of wiki pages

Parameters:

  • project_id_or_key (Integer, String) —

    Project id or project key

Returns:



11
12
13
 
# File 'lib/backlog_kit/client/wiki.rb', line 11

def get_wikis(project_id_or_key)
  get('wikis', project_id_or_key: project_id_or_key)
end

#link_wiki_shared_files(wiki_id, file_ids = []) ⇒ BacklogKit::Response

Link shared files to wiki

Parameters:

  • wiki_id (Integer, String) —

    Wiki page id

  • file_ids (Array) (defaults to: []) —

    List of file ids

Returns:



82
83
84
 
# File 'lib/backlog_kit/client/wiki.rb', line 82

def link_wiki_shared_files(wiki_id, file_ids = [])
  post("wikis/#{wiki_id}/sharedFiles", file_id: file_ids)
end

#unlink_wiki_shared_file(wiki_id, file_id) ⇒ BacklogKit::Response

Unlink a shared file on wiki

Parameters:

  • wiki_id (Integer, String) —

    Wiki page id

  • file_id (Integer, String) —

    Shared file id

Returns:



91
92
93
 
# File 'lib/backlog_kit/client/wiki.rb', line 91

def unlink_wiki_shared_file(wiki_id, file_id)
  delete("wikis/#{wiki_id}/sharedFiles/#{file_id}")
end

#update_wiki(wiki_id, params = {}) ⇒ BacklogKit::Response

Update a wiki page

Parameters:

  • wiki_id (Integer, String) —

    Wiki page id

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

    Request parameters

Returns:



56
57
58
 
# File 'lib/backlog_kit/client/wiki.rb', line 56

def update_wiki(wiki_id, params = {})
  patch("wikis/#{wiki_id}", params)
end