Search This Blog

Breaking

Friday, 28 April 2023

[JIRA API] -> Set JIRA description field with formatting

 Recentally, while doing my jirafication activity, I came across a situation, when I was trying to create a JIRA Story with sonar issue description, but the JIRA Issue, was not updating the formatted description.

It was coming as a plain text which was not much impressive.

So to  implement it, I did the same steps manually first and then check the request from network console. And below are some of my findings:










1. To make text bold: just put the text between *.

For Example: 

Input Text: This isssue is related to Thread.

Expected Output: *This isssue is related to Thread*

This will make this line bold when you will hit with your API.

API: {{JIRA_URL}}/ rest/api/latest/issue

Method: POST

{

"fields": {

"description": "*This isssue is related to Thread*"

}

}

2. To make text in color: put the color code like this:

"{color:#0747a6}This isssue is related to Thread.{color}"

For Example: 

Input Text: This isssue is related to Thread.

Expected Output: This isssue is related to Thread


3. To put Java code: "{code:java} your java code {code}"

As of now, I have just used these formattings. I will update others, if will use them.



No comments:

Post a Comment