Uploaded image for project: 'Jira Data Center'
  1. Jira Data Center
  2. JRASERVER-72844

Jira Server REST API documentation for versions 8.19.x and newer has invalid endpoints

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Low
    • 8.20.12, 9.2.0, 9.1.1
    • 8.21.1, 8.19.0, 8.19.1, 8.20.0, 8.20.1, 8.21.0, 8.22.0, 9.0.0, 9.1.0, 8.20.11, 8.22.6
    • None

    Description

      Issue Summary

      It appears that the developer documentation for Jira Server/Data center REST API starting with 8.19.0 has changed the formatting of the endpoints listed in documentation.

      Example:
      https://docs.atlassian.com/software/jira/docs/api/REST/8.19.0/#issue-getIssue now indicates the endpoint to get an issue is GET /rest/issue/{issueIdOrKey}

      This is a noted change since in 8.18 and all recent versions of the API have had an endpoint naming convention of /rest/api/2/issue/{issueIdOrKey} as explained in https://docs.atlassian.com/software/jira/docs/api/REST/8.18.0/#api/2/issue-getIssue

      Steps to Reproduce

      1. Follow 8.19 REST API documentation to attempt to either create a new issue or GET an existing issue

      Expected Results

      We expect to get back a json payload of the issue created, such as

      {"id":"10025","key":"SCRUM-26","self":"http://localhost:8191/rest/api/2/issue/10025"} 
      

      or when retrieving an existing issue a json payload of that issue details.

      Actual Results

      % curl -u admin:password \
      --request GET \
       -H 'Content-Type: application/json' \
      http://localhost:8191/rest/issue/SCRUM-1
      <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>Oops, you&#39;ve found a dead link. - JIRA</title><script type="text/javascript">contextPath = "";</script><link type='text/css' rel='stylesheet' href='/static-assets/metal-all.css' media='all'><script src='/static-assets/jquery-min.js'></script><script src='/static-assets/metal-all.js'></script><meta name="decorator" content="none" /></head><body class=" error-page error404"><script type="text/javascript">document.body.className += " js-enabled";</script><div id="page"><header id="header" role="banner" aria-label="Site"></header><div id="content"><div class="aui-page-panel" ><div class="aui-page-panel-inner"><main role="main" id="main" class="aui-page-panel-content lowerContent" ><div id="error-state"><span class="error-type"></span><h1>Oops, you&#39;ve found a dead link.</h1><ul><li>Go back to the <a href="javascript:window.history.back()">previous page</a></li><li>Go to the <a href="/secure/MyJiraHome.jspa">Home Page</a></li></ul></div></main></div></div></div><footer id="footer" role="contentinfo"><section class="footer-body"><ul class="atlassian-footer">
          <li>
              Atlassian Jira <a class="seo-link" rel="nofollow" href="https://www.atlassian.com/software/jira">Project Management Software</a>
                  </li>
          <li>
              <a id="about-link" rel="nofollow" href="/secure/AboutPage.jspa/secure/AboutPage.jspa">About Jira</a>
          </li>
          <li>
              <a id="footer-report-problem-link" rel="nofollow" href="/secure/CreateIssue!default.jspa">Report a problem</a>
          </li>
      </ul>
          <p class="atlassian-footer">
              <span class="licensemessage">
                  
              </span>
          </p>
      <div id="footer-logo"><a href="http://www.atlassian.com/" rel="nofollow">Atlassian</a></div></section></footer></div></body></html>%                                            
      

      Workaround

      Please follow the 8.18 REST API documentation until this can be resolved. https://docs.atlassian.com/software/jira/docs/api/REST/8.18.0/

      Attachments

        Issue Links

          Activity

            People

              a803384f6b1d Tomek Prus
              aheinzer Andy Heinzer
              Votes:
              7 Vote for this issue
              Watchers:
              13 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: