module Bugsnag::Api::Client::Comments

Methods for the Errors API

@see docs.bugsnagapiv2.apiary.io/#reference/comments

Public Instance Methods

comment(id, options = {}) click to toggle source

View an Comment

@return [Sawyer::Resource] Requested Comment @see docs.bugsnagapiv2.apiary.io/#reference/errors/comments/view-a-comment

# File lib/bugsnag/api/client/comments.rb, line 25
def comment(id, options = {})
  get "comments/#{id}", options
end
comments(project_id, error_id, options = {}) click to toggle source

List Comments on an Error

@option offset [Number] The pagination offset (not required for general use) @option sort [String] Comments are only sortable by creation time e.g. “created_at” @option direction [String] Which direction to sort the result by, one of: asc, desc @option per_page [Number] How many results to return per page @return [Array<Sawyer::Resource>] List of Error Comments @see docs.bugsnagapiv2.apiary.io/#reference/errors/comments/list-comments-on-an-error

# File lib/bugsnag/api/client/comments.rb, line 17
def comments(project_id, error_id, options = {})
  paginate "projects/#{project_id}/errors/#{error_id}/comments", options
end
create_comment(project_id, error_id, message, options = {}) click to toggle source

Create a Comment on an Error

@return [Sawyer::Resource] The new Comment @see docs.bugsnagapiv2.apiary.io/#reference/errors/comments/create-a-comment-on-an-error

# File lib/bugsnag/api/client/comments.rb, line 33
def create_comment(project_id, error_id, message, options = {})
  post "projects/#{project_id}/errors/#{error_id}/comments", options.merge({:message => message})
end
delete_comment(id, options = {}) click to toggle source

Delete a Comment

@return @see docs.bugsnagapiv2.apiary.io/#reference/errors/comments/delete-a-comment

# File lib/bugsnag/api/client/comments.rb, line 49
def delete_comment(id, options = {})
  boolean_from_response :delete, "comments/#{id}", options
end
update_comment(id, message, options = {}) click to toggle source

Update a Comment

@return [Sawyer::Resource] The updated Comment @see docs.bugsnagapiv2.apiary.io/#reference/errors/comments/update-a-comment

# File lib/bugsnag/api/client/comments.rb, line 41
def update_comment(id, message, options = {})
  patch "comments/#{id}", options.merge({:message => message})
end