Skip to main content

Module confluence_api

Module confluence_api 

Source
Expand description

Confluence Cloud REST API v2 implementation of AtlassianApi.

Uses the Confluence REST API v2 to read and write pages. Pages are fetched with ADF body format and updated with version number increments for optimistic locking.

Structs§

ChildPage
A child page returned from the children API.
ConfluenceApi
Confluence Cloud REST API v2 backend.
ConfluenceAttachment
An attachment on a Confluence page.
ConfluenceAttachmentPage
A page of attachments returned by ConfluenceApi::list_attachments.
ConfluenceComment
A comment on a Confluence page.
ConfluenceLabel
A label on a Confluence page.
ConfluenceSpace
A Confluence space.
ConfluenceSpacePage
A page of spaces returned by ConfluenceApi::list_spaces.
InlineAnchor
Anchor metadata required when creating an inline comment.
MovedPage
Updated page metadata returned by ConfluenceApi::move_page.
PageMetadata
Lightweight metadata about a Confluence page, returned by ConfluenceApi::get_page_metadata.
PageSummary
A summary record for a Confluence page in a space.
PageSummaryPage
A page of PageSummary records returned by ConfluenceApi::list_space_pages.
PageVersion
A single version entry from a Confluence page’s history.

Enums§

CommentKind
Distinguishes the two kinds of Confluence page comments.
MovePosition
Position for ConfluenceApi::move_page. Same-space only — cross-space moves are not supported by the v2 API.
SinceFilter
Filter applied to a version listing.

Functions§

resolve_version
Resolves a user-supplied version reference against a list of PageVersion records returned by ConfluenceApi::list_page_versions.