Updating description field using REST API and Atlassian Document Formatting (ADF)

Isaac Powell_zh3e1e

Using an API call

Referencing ADF:  Document builder (atlassian.com) 

I have successfully set the description field as:

 

{
  "update": {
    "description": [
      {
        "set": {
          "version": 1,
          "type": "doc",
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Hi"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

 

I would like then update the field, adding another line that says "hello again" (not really, this is just test data). I believe swappting "set" for "add" should achieve this:  Advanced field editing using JSON | Cloud automation Cloud | Atlassian Support

My attempts are failing:

{
  "update": {
    "description": [
      {
        "add": {
          "version": 1,
          "type": "doc",
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Hello again"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

 

 

Marcelo Ulloa

Hello 

To resolve this issue when updating the description field using the Jira REST API and ADF (Atlassian Document Format), you should avoid using "add" as it doesn't concatenate text. Instead, you should use "set" and reconstruct the entire document with the new content added. Here's an example:

{
  "update": {
    "description": [
      {
        "set": {
          "version": 1,
          "type": "doc",
          "content": [
            {
              "type": "paragraph",
              "content": [
                { "type": "text", "text": "Existing text" }
              ]
            },
            {
              "type": "paragraph",
              "content": [
                { "type": "text", "text": "Newly added text" }
              ]
            }
          ]
        }
      }
    ]
  }
}