Details
-
Bug
-
Resolution: Timed out
-
Low
-
1
-
Severity 3 - Minor
-
Description
Issue Summary
It is possible to create a page using Atlassian Document Format (ADF) but the Confluence Cloud REST API documentation doesn't mention "editor" as a content type, nor "atlas_doc_format" as a representation. In fact it doesn't seem to define the formats or representations at all, other than by giving a few examples, so is not complete enough for users to work out how to use the API.
Steps to Reproduce
- Consult the Create content section in the API docs to find out how to create a page.
- Scroll to the Body Parameters subsection to find out what to put in the payload.
Expected Results
The body parameter should specify a structure with available formats and representations. It should allow creation of content using any supported format, including ADF.
Actual Results
The body parameter is described only in vague terms:
The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. storage.
Note, editor2 format is used by Atlassian only. anonymous_export_view is the same as 'export_view' format but only content viewable by an anonymous user is included.
It talks about a "body format" without explaining what that means. The example POST given next shows that body actually has a structure and requires a format with a value and a representation, but is not actually a valid payload (should only have one format), and the full set of available formats and representations is not defined.
Workaround
There is a question in Community that includes part of the answer, for ADF at least.
Attachments
Issue Links
- is related to
-
CONFCLOUD-67547 Trying to create a page for new editor using the REST API isn't consistent
- Closed