Details
-
Bug
-
Status: Closed (View Workflow)
-
Low
-
Resolution: Not a bug
-
8
-
Severity 3 - Minor
-
36
-
Description
I am sorry to everyone struggling with the behaviour of the REST API. This behaviour is intentional and we’ll be closing this ticket, but let me give additional context.
Note we have two different versions of the Jira API:
- Version 3: This is the latest version but is in beta. Version 2 and version 3 of the API offer the same collection of operations. However, version 3 provides support for the Atlassian Document Format (ADF) for rich text fields.
- Version 2: This API supports wikimarkup for text formatting and can be found here. This version of the API continues to be supported and offers the full functionality of v3, simply the syntax for text formatting differs.
- While we do support on the fly conversion of markdown in the Jira user interface, neither API supports markdown via the REST API.
Your options:
- You may continue to use v2 of the API along with wikimarkup syntax.
- If you’d like to use v3 along with ADF, we offer the following tools to help:
-
- Documentation for the ADF format.
-
- The ADF Schema can be can be used to validate ADF documents.
-
- The ADF Builder which provides an editor which shows the corresponding ADF.
-
- ADF Utils is an npm module which provides a set of utilities to traverse, modify and create ADF documents.
We’ve created a ticket to track adding support for wikimarkup/ADF in the v3 api which you can follow here: https://ecosystem.atlassian.net/browse/ACJIRA-2499.
— Phil Oye, Group Product Manager, Atlassian
Problem Definition
Adding a comment/description using WiKi markdown works when performed via GUI.
But adding a comment/description via rest API fails with WiKi markdown does not format well with new issue view
Steps to reproduce the issue
Sending the Comment Rest API :
Post https://domain.atlassian.net/rest/api/3/issue/SF-19/comment
{
"body": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "#### [testbox] **test1:** test9 **test2:** test3 **test4 time:** test5 **test8** test7"
}
]
}
]
}
}
==============================
Add Comment with Rest API
Add the comment on GUI
Workaround
Use Rest v2
Attachments
Issue Links
- is related to
-
JRACLOUD-72631 Provide users with a plain text markdown editor
- Gathering Interest
- Mentioned in
- mentioned in
-
Page Loading...
- relates to
-