• We collect Jira feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      1. Identify most useful REST APIs for other plugins
      2. Add documentation in server side code
      3. Alter our build to compile this documentation into a format which the REST API Browser can consume (Developer Toolbox)

          Form Name

            [JSWSERVER-6786] Documentation for REST API

            Andrew added a comment -

            We're pleased to announce that JIRA Agile now has a public REST API. The new officially supported REST API includes a number of improvements over the old private JIRA Agile REST APIs:

            • New resources — We've added a number of new resources to help you interact with JIRA Agile, like the epic and sprint resources.
            • Online documentation — You don't need to mess around looking at private internal API calls anymore. The documentation is available online and will be updated with each release.
            • New documentation theme — The documentation is now easier to parse with expandable sections for resources and better styling.

            Check out the documentation for the latest version here: https://docs.atlassian.com/greenhopper/REST/cloud/

            If you are currently using the private JIRA Agile REST API, see the instructions below:

            • If you have a Connect add-on — Be aware that the resources that are marked as private in JIRA Agile REST Scopes have been deprecated. These private resources will no longer be whitelisted on the 1st November 2015. You must migrate to the new public REST API before this date. Note, there is feature parity between the whitelisted private resources and the new public REST resources.
            • If you have a P2 add-on — Be aware that the private JIRA Agile REST API will remain experimental and may break at any time. You can continue to use the private API, but we recommend that you migrate to the new public REST API. Note, feature parity does not exist between the private and public REST APIs, and we cannot promise that there will be feature parity in future.

            If you have problems using the new JIRA Agile REST API, create an issue in the ACJIRA project on ecosystem.atlassian.net.

            Andrew added a comment - We're pleased to announce that JIRA Agile now has a public REST API. The new officially supported REST API includes a number of improvements over the old private JIRA Agile REST APIs: New resources — We've added a number of new resources to help you interact with JIRA Agile, like the epic and sprint resources. Online documentation — You don't need to mess around looking at private internal API calls anymore. The documentation is available online and will be updated with each release. New documentation theme — The documentation is now easier to parse with expandable sections for resources and better styling. Check out the documentation for the latest version here: https://docs.atlassian.com/greenhopper/REST/cloud/ If you are currently using the private JIRA Agile REST API, see the instructions below: If you have a Connect add-on — Be aware that the resources that are marked as private in JIRA Agile REST Scopes have been deprecated. These private resources will no longer be whitelisted on the 1st November 2015. You must migrate to the new public REST API before this date. Note, there is feature parity between the whitelisted private resources and the new public REST resources. If you have a P2 add-on — Be aware that the private JIRA Agile REST API will remain experimental and may break at any time. You can continue to use the private API, but we recommend that you migrate to the new public REST API. Note, feature parity does not exist between the private and public REST APIs, and we cannot promise that there will be feature parity in future. If you have problems using the new JIRA Agile REST API, create an issue in the ACJIRA project on ecosystem.atlassian.net .

            I've been looking for advanced information on a rapid/agile board through an API call. after some googling and trying stuff, if found the following interface that provides with everything you could possibly need (filterID, swimlanes, Board Name,..)

            https://YOUR_JIRA_SERVER/rest/greenhopper/1.0/rapidviewconfig/editmodel.json?rapidViewId=ID_OF_YOUR_BOARD

            Markus Wissekal added a comment - I've been looking for advanced information on a rapid/agile board through an API call. after some googling and trying stuff, if found the following interface that provides with everything you could possibly need (filterID, swimlanes, Board Name,..) https://YOUR_JIRA_SERVER/rest/greenhopper/1.0/rapidviewconfig/editmodel.json?rapidViewId=ID_OF_YOUR_BOARD

            MattS added a comment - - edited

            It looks like there is now some documentation of the JIRA Agile REST API at https://docs.atlassian.com/greenhopper/REST/cloud and https://docs.atlassian.com/greenhopper/REST/6.7.3/

            MattS added a comment - - edited It looks like there is now some documentation of the JIRA Agile REST API at https://docs.atlassian.com/greenhopper/REST/cloud and https://docs.atlassian.com/greenhopper/REST/6.7.3/

            Usually in our company boards are shared to projects. Once a project is deleted the board becomes visible only for the one who created the board filter which means a single jira-administrator is not able to enumerate all boards when boards are created by different jira-administrators.

            This makes it impossible for us to create an automated job running on behalf of a member of jira-administrators that cleans up all boards whose projects have been deleted. That way we get more and more garbage boards on our system.

            Please improve <baseurl>/rest/greenhopper/1.0/rapidviews/list to enumerate really all boards on the system. Please check https://support.atlassian.com/servicedesk/agent/GHS/issue/GHS-16530 for the circumstances when the API does not work as expected.

            Dieter Greiner added a comment - Usually in our company boards are shared to projects. Once a project is deleted the board becomes visible only for the one who created the board filter which means a single jira-administrator is not able to enumerate all boards when boards are created by different jira-administrators. This makes it impossible for us to create an automated job running on behalf of a member of jira-administrators that cleans up all boards whose projects have been deleted. That way we get more and more garbage boards on our system. Please improve <baseurl>/rest/greenhopper/1.0/rapidviews/list to enumerate really all boards on the system. Please check https://support.atlassian.com/servicedesk/agent/GHS/issue/GHS-16530 for the circumstances when the API does not work as expected.

            Shahim Essaid added a comment - - edited

            I was able to find some very useful information from: https://jira.atlassian.com/rest/greenhopper/1.0/application.wadl

            I should add that I found the above link (and many others) in the HTML source of the page at: https://bunjil.jira-dev.com/plugins/servlet/restbrowser#/

            Edit: I later figured out why I wasn't able to see the same information in the REST browser as many were recommending. Initially I was not able to find the "Show only public" check-box to uncheck it because it was hidden behind a timezone warning at the top of the page. I'm now able to see the same information in a much friendlier way in the Web browser.

            Shahim Essaid added a comment - - edited I was able to find some very useful information from: https://jira.atlassian.com/rest/greenhopper/1.0/application.wadl I should add that I found the above link (and many others) in the HTML source of the page at: https://bunjil.jira-dev.com/plugins/servlet/restbrowser#/ Edit: I later figured out why I wasn't able to see the same information in the REST browser as many were recommending. Initially I was not able to find the "Show only public" check-box to uncheck it because it was hidden behind a timezone warning at the top of the page. I'm now able to see the same information in a much friendlier way in the Web browser.

            From my side I wanted to comment that we are using the following JIRA Agile APIs:

            • /rest/greenhopper/1.0/rapidview/{rapid_view_id} to get the information about Scrum board
            • /rest/greenhopper/1.0/sprintquery/{rapid_view_id}?includeFutureSprints=true to get the information about sprints that are included in selected Scrum board

            We would like to have these REST APIs available also when using Atlassian Connect as otherwise there is no way how to get information about Scrum boards in JIRA Cloud.

            Raimonds Simanovskis added a comment - From my side I wanted to comment that we are using the following JIRA Agile APIs: /rest/greenhopper/1.0/rapidview/{rapid_view_id } to get the information about Scrum board /rest/greenhopper/1.0/sprintquery/{rapid_view_id}?includeFutureSprints=true to get the information about sprints that are included in selected Scrum board We would like to have these REST APIs available also when using Atlassian Connect as otherwise there is no way how to get information about Scrum boards in JIRA Cloud.

            bgatz, the specific information that we're after via the API are the following:

            • General information about sprints (start, end dates)
            • Tickets contained within the sprint (those initially committed and those that are the result of scope changes--both in and out)

            The remainder of the information we're after can be gathered from this data, such as trending of work for/scope changes of components/labels, "found" work, perpetually deferred work.

            We also run different sprint cadences across the business based on types of work and agile maturity of teams, so a way to "discover"/list sprints for a project would be useful.

            Jeff Weiss added a comment - bgatz , the specific information that we're after via the API are the following: General information about sprints (start, end dates) Tickets contained within the sprint (those initially committed and those that are the result of scope changes--both in and out) The remainder of the information we're after can be gathered from this data, such as trending of work for/scope changes of components/labels, "found" work, perpetually deferred work. We also run different sprint cadences across the business based on types of work and agile maturity of teams, so a way to "discover"/list sprints for a project would be useful.

            jeff.weiss, we will do our best to follow this fine example in JIRA Agile as well. But, you must admit, if we were forced to release documentation together with stable API, it is not really going to be an example of "f#@king the customers"?

            Bartosz Gatz (Inactive) added a comment - jeff.weiss , we will do our best to follow this fine example in JIRA Agile as well. But, you must admit, if we were forced to release documentation together with stable API, it is not really going to be an example of "f#@king the customers"?

            Jeff Weiss added a comment -

            bgatz, I understand the interfaces may be in flux. That's fine, but there's also precedent in Atlassian releasing and documenting an API prior to it being "finalized": https://developer.atlassian.com/display/CONFDEV/Confluence+REST+APIs+-+Prototype+Only

            Jeff Weiss added a comment - bgatz , I understand the interfaces may be in flux. That's fine, but there's also precedent in Atlassian releasing and documenting an API prior to it being "finalized": https://developer.atlassian.com/display/CONFDEV/Confluence+REST+APIs+-+Prototype+Only

            jeff.weiss, as I said in my previous comment, we are working on it, and the work will be delivered in several stages. Mind that the documentation for an API is the second step after declaring a given REST method to be part of an API. We do have a tonne of REST methods in JIRA Agile, but very few of them are actually declared to be public API methods: they are private methods instead and we use internally at Atlassian (in most cases: to communicate our proprietary frontend with our proprietary backend). They are not API yet, but as same moment as we evolve them to be public REST API the public and official documentation will be provided as well.

            It might help if you tell us what you are looking for in particular.

            I'm also changing the assignee, so that it is not misleading anymore. FYI, the assignee listed here is usually not the very person implementing a given request: in fact in this case there is a whole team working on API related topics.

            Thanks for your comments and understanding.

            Bartosz Gatz (Inactive) added a comment - jeff.weiss , as I said in my previous comment, we are working on it, and the work will be delivered in several stages. Mind that the documentation for an API is the second step after declaring a given REST method to be part of an API. We do have a tonne of REST methods in JIRA Agile, but very few of them are actually declared to be public API methods: they are private methods instead and we use internally at Atlassian (in most cases: to communicate our proprietary frontend with our proprietary backend). They are not API yet , but as same moment as we evolve them to be public REST API the public and official documentation will be provided as well. It might help if you tell us what you are looking for in particular. I'm also changing the assignee, so that it is not misleading anymore. FYI, the assignee listed here is usually not the very person implementing a given request: in fact in this case there is a whole team working on API related topics. Thanks for your comments and understanding.

              alui Andrew
              mtokar Michael Tokar
              Votes:
              47 Vote for this issue
              Watchers:
              47 Start watching this issue

                Created:
                Updated:
                Resolved: