Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added getComments method to src/Jira/Api.php under addComment #79

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added getComments method to src/Jira/Api.php under addComment #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/Jira/Api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,27 @@ public function addComment($issueKey, $params)
return $this->api(self::REQUEST_POST, sprintf('/rest/api/2/issue/%s/comment', $issueKey), $params);
}

/**
* get comments from a ticket
*
* issue key should be YOURPROJ-221
*
* @param $issueKey
* @param $params
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This DocBlock is malformed:

  • no parameter data types
  • no parameter description
  • short method description doesn't start with capital letter

* @return mixed
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What return values are possible?

*/

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove empty line before DocBlock and method declaration.

public function getComments($issueKey, $params)
{
if (is_string($params)) {
// if $params is scalar string value -> wrapping it properly
$params = array(
'body' => $params
);
}
return $this->api(self::REQUEST_GET, sprintf("/rest/api/2/issue/%s/comment", $issueKey), $params);
}

/**
* Get all worklogs for an issue
*
Expand Down