module Gitlab::Client::UserSnippets
Defines methods related to user snippets. @see docs.gitlab.com/ce/api/snippets.html
Public Instance Methods
Create a new snippet.
@example
Gitlab.create_user_snippet({ title: 'REST', file_name: 'api.rb', content: 'some code', description: 'Hello World snippet', visibility: 'public'})
@param [Hash] options A customizable set of options. @option options [String] :title (required) Title of a snippet. @option options [String] :file_name (required) Name of a snippet file. @option options [String] :content (required) Content of a snippet. @option options [String] :description (optional) Description of a snippet. @option options [String] :visibility (optional) visibility of a snippet. @return [Gitlab::ObjectifiedHash] Information about created snippet.
# File lib/gitlab/client/user_snippets.rb, line 54 def create_user_snippet(options = {}) post('/snippets', body: options) end
Delete an existing snippet.
@example
Gitlab.delete_user_snippet(14)
@param [Integer] id ID of snippet to delete. @return [void] This API call returns an empty response body.
# File lib/gitlab/client/user_snippets.rb, line 83 def delete_user_snippet(id) delete("/snippets/#{id}") end
Update an existing snippet.
@example
Gitlab.edit_user_snippet(34, { file_name: 'README.txt' }) Gitlab.edit_user_snippet(34, { file_name: 'README.txt', title: 'New title' })
@param [Integer] id ID of snippet to update. @param [Hash] options A customizable set of options. @option options [String] :title (optional) Title of a snippet. @option options [String] :file_name (optional) Name of a snippet file. @option options [String] :content (optional) Content of a snippet. @option options [String] :description (optional) Description of a snippet. @option options [String] :visibility (optional) visibility of a snippet. @return [Gitlab::ObjectifiedHash] Information about updated snippet.
# File lib/gitlab/client/user_snippets.rb, line 72 def edit_user_snippet(id, options = {}) put("/snippets/#{id}", body: options) end
List all public snippets.
@example
Gitlab.public_snippets Gitlab.public_snippets(per_page: 2, page: 1)
@param [Hash] options A customizable set of options. @option options [String] :per_page (optional) Number of snippets to return per page. @option options [String] :page (optional) Page to retrieve.
@return [Array<Gitlab::ObjectifiedHash>] List of all public snippets
# File lib/gitlab/client/user_snippets.rb, line 98 def public_snippets(options = {}) get('/snippets/public', query: options) end
Get user agent details for a snippet.
@example
Gitlab.snippet_user_agent_details(1)
@param [Integer] id ID of snippet to delete.
@return [Array<Gitlab::ObjectifiedHash>] Details of the user agent
# File lib/gitlab/client/user_snippets.rb, line 110 def snippet_user_agent_details(id) get("/snippets/#{id}/user_agent_detail") end
Get a single snippet.
@example
Gitlab.user_snippet(1)
@param [Integer] id ID of snippet to retrieve. @return [Gitlab::ObjectifiedHash] Information about the user snippet
# File lib/gitlab/client/user_snippets.rb, line 24 def user_snippet(id) get("/snippets/#{id}") end
Get raw contents of a single snippet.
@example
Gitlab.user_snippet_raw(1)
@param [Integer] id ID of snippet to retrieve. @return [String] User snippet text
# File lib/gitlab/client/user_snippets.rb, line 35 def user_snippet_raw(id) get("/snippets/#{id}/raw", format: nil, headers: { Accept: 'text/plain' }, parser: ::Gitlab::Request::Parser) end
Get a list of the snippets of the current user.
@example
Gitlab.user_snippets
@return [Array<Gitlab::ObjectifiedHash>] List of snippets of current user
# File lib/gitlab/client/user_snippets.rb, line 13 def user_snippets get('/snippets') end