getComments method

Future<PageOfComments> getComments({
  1. required String issueIdOrKey,
  2. int? startAt,
  3. int? maxResults,
  4. String? orderBy,
  5. String? expand,
})

Returns all comments for an issue.

This operation can be accessed anonymously.

Permissions required: Comments are included in the response where the user has:

  • Browse projects project permission for the project containing the comment.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.

Implementation

Future<PageOfComments> getComments(
    {required String issueIdOrKey,
    int? startAt,
    int? maxResults,
    String? orderBy,
    String? expand}) async {
  return PageOfComments.fromJson(await _client.send(
    'get',
    'rest/api/3/issue/{issueIdOrKey}/comment',
    pathParameters: {
      'issueIdOrKey': issueIdOrKey,
    },
    queryParameters: {
      if (startAt != null) 'startAt': '$startAt',
      if (maxResults != null) 'maxResults': '$maxResults',
      if (orderBy != null) 'orderBy': orderBy,
      if (expand != null) 'expand': expand,
    },
  ));
}