How can I add additional data to description field in REST API for Jira?

Mont_8hwp75

Similar to this question:https://community.atlassian.com/t5/Jira-questions/How-do-you-create-a-Jira-issue-with-code-snippet-in-the/qaq-p/1234646

 

There doesn't seem to be any documentation on how to do this. Most the examples and documentation list a single line description, which is not the case many times in creating JIRA descriptions. The lack of error messages when calling the JIRA API doesn't help, as one small incorrect syntax can give a 400 client error.

It seems as if it's more black box testing calling the API to determine what works.

How do I include multiple lines in the description or key value pairs to make a successful jira API call? I'm currently calling this from python and have tested to see if the python to json syntax is correct and it is. However, still receive a 400 error after repeating the steps and same code in the link above.

Any suggestions and resolutions?

 

 

 

unknown

Hello @Mont 

"Any suggestions and resolutions?"

Start by reading the documentation on Atlassian Document Format (ADF). This is the structured language used to build the content of the description field via the v3 REST API of Jira Cloud (which I took a random, wild guess you're referring to, since that's what the question you linked to is discussing).

To make a soft line break, you just put a newline char '\n' into the JSON text object:

{
 "type": "doc",
 "version": 1,
 "content": [
  {
   "type": "paragraph",
   "content": [
    {
     "type": "text",
     "text": "This is the first line\nThis is the second line"
    }
   ]
  }
 ]
}

To make a hard line break, put a hardBreak object between the JSON text objects:

{
 "version": 1,
 "type": "doc",
 "content": [
  {
   "type": "paragraph",
   "content": [
    {
     "type": "text",
     "text": "This is the first line"
    },
    {
     "type": "hardBreak"
    },
    {
     "type": "text",
     "text": "This is the second line"
    }
   ]
  }
 ]
}

Use the Document Builder to type in plain or wiki markdown text to see what the resulting ADF is.

There is also the Document Viewer where you can do the opposite... type in ADF and it will render the resulting text.

Have fun

<VeryBigHint>

Oh, and when you ask questions and don't say which type of Jira you are using (Cloud, Server or DataCentre), you don't say which REST API endpoint you are using, you don't provide code samples of what you are trying to do and you don't tag your post with the correct product tags, your question is just like a black box where people have just try and guess what it refers to.

</VeryBigHint>