atlassian.jira.comments — net.clojars.deadmeme5441/atlassian-sdk 0.2.0

Jira Cloud issue comments and comment properties.

Covers two tag groups from the Jira Platform v3 REST API:

• Issue comments (/rest/api/3/issue/{issueIdOrKey}/comment, /rest/api/3/comment/list)
• Issue comment properties (/rest/api/3/comment/{commentId}/properties/...)

Comment bodies are Atlassian Document Format (ADF). Use atlassian.jira.adf/text->adf to build a valid body from plain text.

add-comment clj

(add-comment client issue-id-or-key body)

(add-comment client issue-id-or-key body opts)

Add a comment to an issue.

Path params: issue-id-or-key — the ID or key of the issue. Body: Comment schema. The :body field is ADF; use atlassian.jira.adf/text->adf to build it from plain text. Example: {:body (adf/text->adf "This is my comment.") :visibility {:type "role" :value "Developers"}} Query opts: :expand (string).

POST /rest/api/3/issue/{issueIdOrKey}/comment

comments-by-ids clj

(comments-by-ids client body)

(comments-by-ids client body opts)

Get comments by IDs (POST /rest/api/3/comment/list).

Body: IssueCommentListRequestBean — {:ids [<long>, ...]}. Maximum 1000 IDs. Query opts: :expand (string) — comma-separated expansion options.

POST /rest/api/3/comment/list

delete-comment clj

(delete-comment client issue-id-or-key id)

Delete a comment from an issue.

Path params: issue-id-or-key — the ID or key of the issue. id — the ID of the comment.

DELETE /rest/api/3/issue/{issueIdOrKey}/comment/{id}

delete-comment-property clj

(delete-comment-property client comment-id property-key)

Delete a property from a comment.

Path params: comment-id — the ID of the comment. property-key — the key of the property.

DELETE /rest/api/3/comment/{commentId}/properties/{propertyKey}

get-comment clj

(get-comment client issue-id-or-key id)

(get-comment client issue-id-or-key id opts)

Get a single comment from an issue.

Path params: issue-id-or-key — the ID or key of the issue. id — the ID of the comment. Query opts: :expand (string).

GET /rest/api/3/issue/{issueIdOrKey}/comment/{id}

get-comment-property clj

(get-comment-property client comment-id property-key)

Get a property of a comment.

Path params: comment-id — the ID of the comment. property-key — the key of the property.

GET /rest/api/3/comment/{commentId}/properties/{propertyKey}

get-comment-property-keys clj

(get-comment-property-keys client comment-id)

Get the property keys for a comment.

Path params: comment-id — the ID of the comment.

GET /rest/api/3/comment/{commentId}/properties

get-comments clj

(get-comments client issue-id-or-key)

(get-comments client issue-id-or-key opts)

Get all comments for an issue.

Path params: issue-id-or-key — the ID or key of the issue. Query opts: :startAt, :maxResults, :orderBy, :expand.

GET /rest/api/3/issue/{issueIdOrKey}/comment

set-comment-property clj

(set-comment-property client comment-id property-key body)

Set a property on a comment (creates or replaces).

Path params: comment-id — the ID of the comment. property-key — the key of the property (max 255 chars). Body: arbitrary JSON value (the property value).

PUT /rest/api/3/comment/{commentId}/properties/{propertyKey}

update-comment clj

(update-comment client issue-id-or-key id body)

(update-comment client issue-id-or-key id body opts)

Update an existing comment on an issue.

Path params: issue-id-or-key — the ID or key of the issue. id — the ID of the comment. Body: Comment schema. The :body field is ADF; use atlassian.jira.adf/text->adf to build it from plain text. Query opts: :notifyUsers (boolean), :overrideEditableFlag (boolean), :expand (string).

PUT /rest/api/3/issue/{issueIdOrKey}/comment/{id}