Allow to comment issue

[Koisell]

We can comment issue via the update API but using direct API is
easier. This commit allows direct support to add comment to an issue.

[r2sd]

Would really appreciate if you could explain how to use the update API to add a comment.

Thanks!

client.updateIssue(
    "ISSUE-1",
    IssuePayload.apply(
      IssueField.apply("update", Json.obj("comment"-> Json.arr(Json.obj("add" -> Json.obj("body" -> Json.fromString("API Test"))))))
    )
  )

returns

Left(com.allantl.jira4s.v2.domain.errors.GenericError: Field 'update' cannot be set. It is not on the appropriate screen, or unknown.)

The same api works on REST with the body:

{
  "update": {
    "comment": [
      {
        "add": {
          "body": "API test"
        }
      }
    ]
  }
}

[Koisell]

Like the error message explain there is no 'update' field. Fields refer to comment summery. It's explained in Jira documentation. One simple option if you want to send JSON-like call is to not specify fields.

      IssuePayload(
        Nil,
        None,
        Some(
          Json.obj(
            "comment" -> Json.arr(
              Json.obj(
                "add" -> Json.obj(
                  "body" -> "task done!")
                )
              )
            )
          )
        )
      )

[Koisell]

BTW next time you have such question on Github you should make an issue. PR comments should be reserved to talk about the PR. If you think it's relevant you can then link the issue with a PR.

[r2sd]

Thanks a lot @Koisell , that worked perfect. Also, thanks for the tip on issue/PR. Will use it next time!