Trying to include a link in description field API v 3

Eric Thomas August 22, 2019

I have an application that creates templated stories based on a template stored in an xml file.  We have documents we want to include in the description for reference and when I try to include the link (Google Docs) the result is not clickable.  I tried a few things such as the [title|http://link,com]  which does not work and If I use html markup that shows the mark up.

Thanks

1 answer

1 vote
DPKJ
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
August 22, 2019

Jira cloud API accepts ADF (Atlassian Document Format) for `Description Field`.

So you need to send something like this in API as payload against `Description` field.

{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Google","marks":[{"type":"link","attrs":{"href":"http://google.com"}}]}]}]}

 

You can learn about ADF in this session/talk

https://www.atlassian.com/atlascamp/watch-sessions/the-atlassian-platform-for-developers/the-atlassian-document-format-is-coming-to-an-api-near-you

molukaka September 13, 2021

thanks for this...worked like a charm

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events