Swagger Description for JIRA

Edward B August 17, 2017
I'm looking for the swagger.json (OpenAPI) files for JIRAs REST API. I have found the documentation which using RADAR was generated from it, but I really need the json definition instead. Bitbucket exposes it but I'm unable to find JIRAs at all. Can someone please provide a link to it?

5 answers

3 votes
Andrew Garland
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
January 26, 2018
Gonchik Tsymzhitov
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
September 16, 2020

Thanks

2 votes
Night Hawk
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
October 2, 2018

tldr; https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json

Not sure if it was added recently as I'm new to Atlassian products in general but what you seek is currently hiding in plain sight.

Go to: https://developer.atlassian.com/cloud/jira/platform/rest/v3/

When the page loads, you'll see a subdued button with text "Run in Postman", and next to it another button with three dots. Clicking the three dots will pop a new tab and go to the link I've pasted at the top of this message.

Gerardo Lima
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
January 30, 2019

Thank you! 

emacdonald
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
July 1, 2020

Does a similar link exist for Jira Server? I didn't see it here: https://developer.atlassian.com/server/jira/platform/rest-apis/

:-(

Like Surender Babu G likes this
1 vote
adrianchandler
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
October 9, 2017

Hi Edward,

Here is a suggested route you might take...

Jira does provide a wadl description at https://docs.atlassian.com/jira/REST/server/jira-rest-plugin.wadl

so perhaps you can covert it into swagger.json via https://apimatic.io/transformer 

0 votes
Phil Branum
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
November 17, 2020

I see that this is an older thread, but is still relevant to what I am looking for.

I am trying to consume the swagger spec from here (using VS 2019):

However, the generated files contain 2 duplicated method definitions, making the results unusable without modifications.

The methods are:

  • RestApi3IssueRemotelinkGetAsync
  • RestApi3IssueRemotelinkDeleteAsync

I am new to working with OpenApi, so I am not sure if this is an API definition issue or a tool issue. I am using the "Unchase OpenAPI Connected Service" extension for VS 2019, as the built-in swagger support does not even recognize the above swagger definition.

Any suggestions on this would be appreciated.

0 votes
somethingblue
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
August 18, 2017

Hi Edward,

It look like that is generated from an add-on for Confluence called the Open API Documentation for Confluence.  I checked and they do not have an add-on for JIRA.

I see that Bitbucket exposes it in the API, however, looking at the JIRA API I do not see a path that provides swagger.json output.

You can create a Suggestion to have this added to JIRA at JAC.  If you do so please post the link to the ticket here so the community can vote on it and add impact.

Cheers,

Branden

Edward B August 18, 2017

Hello Branden


The  Open API Documentation for Confluence add-on takes a swagger.json file like the one I'm after and produces confluence documentation, much like RADAR does. For Atlassian to have produced their documentation using RADAR then they must have had a copy of that json file. I don't necessarily want it to be exposed as bitbuckets is, though that would certainly be lovely. Instead I'm aftet a one off copy of that json, wherever it may be. Pastebin, dropbox, I'm not fussy, but it definitely exists somewhere otherwise JIRAs documentation wouldn't exist.

Kind Regards

Ed

Suggest an answer

Log in or Sign up to answer