class Tinybucket::Api::CommentsApi
Comments Api
client
@!attribute [rw] repo_owner
@return [String] repository owner name.
@!attribute [rw] repo_slug
@return [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repository slug}.
@!attribute [rw] commented_to
@return [Tinybucket::Model::Commit, Tinybucket::Model::PullRequest]
Attributes
Public Instance Methods
Send 'GET a individual comment' request.
This method send different request depend on 'commented_to' attribute.
@note When 'commented_to' is {Tinybucket::Model::Commit} instance,
this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments/%7Bcomment_id%7D#get GET an individual commit comment}.
@note When 'commented_to' is {Tinybucket::Model::PullRequest} instance,
this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments/%7Bcomment_id%7D#get GET an individual pull request comment}.
@param comment_id [String] comment identifier @param options [Hash] @return [Tinybucket::Model::Comment]
# File lib/tinybucket/api/comments_api.rb, line 56 def find(comment_id, options = {}) comment = get_path(path_to_find(comment_id), options, get_parser(:object, Tinybucket::Model::Comment)) associate_with_target(comment) comment end
Send 'GET a list of comments' request.
This method send different request depend on 'commented_to' attribute.
@note When 'commented_to' is {Tinybucket::Model::Commit} instance,
this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments#get GET a list of commit comments}.
@note When 'commented_to' is {Tinybucket::Model::PullRequest} instance,
this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments#get GET a list of pull request comments}.
@param options [Hash] @return [Tinybucket::Model::Page]
# File lib/tinybucket/api/comments_api.rb, line 33 def list(options = {}) list = get_path(path_to_list, options, get_parser(:collection, Tinybucket::Model::Comment)) associate_with_target(list) list end
Private Instance Methods
# File lib/tinybucket/api/comments_api.rb, line 67 def associate_with_target(result) case result when Tinybucket::Model::Comment result.commented_to = commented_to when Tinybucket::Model::Page result.items.map { |m| m.commented_to = commented_to } else raise ArgumentError, "Invalid result: #{result.inspect}" end result end