Liking cljdoc? Tell your friends :D

atlassian.confluence.v2.comments

Confluence Cloud v2 Comments API — footer and inline comments.

Cursor-paginated list endpoints return {:results [...] :_links {:next ...}}. Page with the cursor query param; use atlassian.confluence.client/next-cursor to extract the cursor from a response.

Comment bodies use storage representation: {:body {:representation "storage" :value "<p>Hello</p>"}}

Confluence Cloud v2 Comments API — footer and inline comments.

Cursor-paginated list endpoints return {:results [...] :_links {:next ...}}.
Page with the `cursor` query param; use `atlassian.confluence.client/next-cursor`
to extract the cursor from a response.

Comment bodies use storage representation:
  {:body {:representation "storage" :value "<p>Hello</p>"}}
raw docstring

(create-footer-comment client body)
(create-footer-comment client body opts)

Create footer comment. POST /wiki/api/v2/footer-comments Body: CreateFooterCommentModel — keys: pageId, blogPostId, parentCommentId, attachmentId, customContentId, body {:representation "storage" :value "..."}. Provide exactly one of pageId/blogPostId/attachmentId/customContentId for top-level, or parentCommentId for a reply.

Create footer comment. POST /wiki/api/v2/footer-comments
Body: CreateFooterCommentModel — keys: pageId, blogPostId, parentCommentId,
attachmentId, customContentId, body {:representation "storage" :value "..."}.
Provide exactly one of pageId/blogPostId/attachmentId/customContentId for top-level,
or parentCommentId for a reply.
sourceraw docstring

create-inline-commentclj

(create-inline-comment client body)
(create-inline-comment client body opts)

Create inline comment. POST /wiki/api/v2/inline-comments Body: CreateInlineCommentModel — keys: pageId, blogPostId, parentCommentId, body {:representation "storage" :value "..."}, inlineCommentProperties {:textSelection "..." :textSelectionMatchCount N :textSelectionMatchIndex N}. inlineCommentProperties required for top-level inline comments.

Create inline comment. POST /wiki/api/v2/inline-comments
Body: CreateInlineCommentModel — keys: pageId, blogPostId, parentCommentId,
body {:representation "storage" :value "..."}, inlineCommentProperties
{:textSelection "..." :textSelectionMatchCount N :textSelectionMatchIndex N}.
inlineCommentProperties required for top-level inline comments.
sourceraw docstring

(delete-footer-comment client comment-id)

Delete footer comment. DELETE /wiki/api/v2/footer-comments/{comment-id} Path params: comment-id (integer) — comment ID.

Delete footer comment. DELETE /wiki/api/v2/footer-comments/{comment-id}
Path params: comment-id (integer) — comment ID.
sourceraw docstring

delete-inline-commentclj

(delete-inline-comment client comment-id)

Delete inline comment. DELETE /wiki/api/v2/inline-comments/{comment-id} Path params: comment-id (integer) — comment ID.

Delete inline comment. DELETE /wiki/api/v2/inline-comments/{comment-id}
Path params: comment-id (integer) — comment ID.
sourceraw docstring

get-attachment-commentsclj

(get-attachment-comments client id)
(get-attachment-comments client id opts)

Get attachment comments. GET /wiki/api/v2/attachments/{id}/footer-comments Path params: id (string) — attachment ID. Optional query opts: body-format, cursor, limit, sort, version.

Get attachment comments. GET /wiki/api/v2/attachments/{id}/footer-comments
Path params: id (string) — attachment ID.
Optional query opts: body-format, cursor, limit, sort, version.
sourceraw docstring

get-blog-post-footer-commentsclj

(get-blog-post-footer-comments client id)
(get-blog-post-footer-comments client id opts)

Get footer comments for blog post. GET /wiki/api/v2/blogposts/{id}/footer-comments Path params: id (integer) — blog post ID. Optional query opts: body-format, status, sort, cursor, limit.

Get footer comments for blog post. GET /wiki/api/v2/blogposts/{id}/footer-comments
Path params: id (integer) — blog post ID.
Optional query opts: body-format, status, sort, cursor, limit.
sourceraw docstring

get-blog-post-inline-commentsclj

(get-blog-post-inline-comments client id)
(get-blog-post-inline-comments client id opts)

Get inline comments for blog post. GET /wiki/api/v2/blogposts/{id}/inline-comments Path params: id (integer) — blog post ID. Optional query opts: body-format, status, resolution-status, sort, cursor, limit.

Get inline comments for blog post. GET /wiki/api/v2/blogposts/{id}/inline-comments
Path params: id (integer) — blog post ID.
Optional query opts: body-format, status, resolution-status, sort, cursor, limit.
sourceraw docstring

get-custom-content-commentsclj

(get-custom-content-comments client id)
(get-custom-content-comments client id opts)

Get custom content comments. GET /wiki/api/v2/custom-content/{id}/footer-comments Path params: id (integer) — custom content ID. Optional query opts: body-format, cursor, limit, sort.

Get custom content comments. GET /wiki/api/v2/custom-content/{id}/footer-comments
Path params: id (integer) — custom content ID.
Optional query opts: body-format, cursor, limit, sort.
sourceraw docstring

(get-footer-comment-by-id client comment-id)
(get-footer-comment-by-id client comment-id opts)

Get footer comment by id. GET /wiki/api/v2/footer-comments/{comment-id} Path params: comment-id (integer) — comment ID. Optional query opts: body-format, version, include-properties, include-operations, include-likes, include-versions, include-version.

Get footer comment by id. GET /wiki/api/v2/footer-comments/{comment-id}
Path params: comment-id (integer) — comment ID.
Optional query opts: body-format, version, include-properties,
include-operations, include-likes, include-versions, include-version.
sourceraw docstring

(get-footer-comment-children client id)
(get-footer-comment-children client id opts)

Get children footer comments. GET /wiki/api/v2/footer-comments/{id}/children Path params: id (integer) — parent comment ID. Optional query opts: body-format, sort, cursor, limit.

Get children footer comments. GET /wiki/api/v2/footer-comments/{id}/children
Path params: id (integer) — parent comment ID.
Optional query opts: body-format, sort, cursor, limit.
sourceraw docstring

(get-footer-comments client)
(get-footer-comments client opts)

Get footer comments. GET /wiki/api/v2/footer-comments All params are optional query opts: body-format, sort, cursor, limit.

Get footer comments. GET /wiki/api/v2/footer-comments
All params are optional query opts: body-format, sort, cursor, limit.
sourceraw docstring

get-inline-comment-by-idclj

(get-inline-comment-by-id client comment-id)
(get-inline-comment-by-id client comment-id opts)

Get inline comment by id. GET /wiki/api/v2/inline-comments/{comment-id} Path params: comment-id (integer) — comment ID. Optional query opts: body-format, version, include-properties, include-operations, include-likes, include-versions, include-version.

Get inline comment by id. GET /wiki/api/v2/inline-comments/{comment-id}
Path params: comment-id (integer) — comment ID.
Optional query opts: body-format, version, include-properties,
include-operations, include-likes, include-versions, include-version.
sourceraw docstring

get-inline-comment-childrenclj

(get-inline-comment-children client id)
(get-inline-comment-children client id opts)

Get children inline comments. GET /wiki/api/v2/inline-comments/{id}/children Path params: id (integer) — parent comment ID. Optional query opts: body-format, sort, cursor, limit.

Get children inline comments. GET /wiki/api/v2/inline-comments/{id}/children
Path params: id (integer) — parent comment ID.
Optional query opts: body-format, sort, cursor, limit.
sourceraw docstring

get-inline-commentsclj

(get-inline-comments client)
(get-inline-comments client opts)

Get inline comments. GET /wiki/api/v2/inline-comments All params are optional query opts: body-format, sort, cursor, limit.

Get inline comments. GET /wiki/api/v2/inline-comments
All params are optional query opts: body-format, sort, cursor, limit.
sourceraw docstring

(get-page-footer-comments client id)
(get-page-footer-comments client id opts)

Get footer comments for page. GET /wiki/api/v2/pages/{id}/footer-comments Path params: id (integer) — page ID. Optional query opts: body-format, status, sort, cursor, limit.

Get footer comments for page. GET /wiki/api/v2/pages/{id}/footer-comments
Path params: id (integer) — page ID.
Optional query opts: body-format, status, sort, cursor, limit.
sourceraw docstring

get-page-inline-commentsclj

(get-page-inline-comments client id)
(get-page-inline-comments client id opts)

Get inline comments for page. GET /wiki/api/v2/pages/{id}/inline-comments Path params: id (integer) — page ID. Optional query opts: body-format, status, resolution-status, sort, cursor, limit.

Get inline comments for page. GET /wiki/api/v2/pages/{id}/inline-comments
Path params: id (integer) — page ID.
Optional query opts: body-format, status, resolution-status, sort, cursor, limit.
sourceraw docstring

(update-footer-comment client comment-id body)
(update-footer-comment client comment-id body opts)

Update footer comment. PUT /wiki/api/v2/footer-comments/{comment-id} Path params: comment-id (integer) — comment ID. Body: UpdateFooterCommentModel — keys: version {:number N :message "..."}, body {:representation "storage" :value "..."}.

Update footer comment. PUT /wiki/api/v2/footer-comments/{comment-id}
Path params: comment-id (integer) — comment ID.
Body: UpdateFooterCommentModel — keys: version {:number N :message "..."},
body {:representation "storage" :value "..."}.
sourceraw docstring

update-inline-commentclj

(update-inline-comment client comment-id body)
(update-inline-comment client comment-id body opts)

Update inline comment. PUT /wiki/api/v2/inline-comments/{comment-id} Path params: comment-id (integer) — comment ID. Body: UpdateInlineCommentModel — keys: version {:number N :message "..."}, body {:representation "storage" :value "..."}, resolved (boolean).

Update inline comment. PUT /wiki/api/v2/inline-comments/{comment-id}
Path params: comment-id (integer) — comment ID.
Body: UpdateInlineCommentModel — keys: version {:number N :message "..."},
body {:representation "storage" :value "..."}, resolved (boolean).
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close