Jira REST API documentation contains incorrect parameters for pagination

XMLWordPrintable

    • Type: Bug
    • Resolution: Fixed
    • Priority: Low
    • None
    • Affects Version/s: 9.0.0, 10.0.0, 11.0.0
    • Component/s: Documentation - All
    • 9
    • Severity 3 - Minor

      Issue Summary

      The Jira REST API documentation contains incorrect parameters in the example REST call for pagination, which limits the response size for resources. 

      Expected Results

      The pagination request mentioned in the REST API documentation should contain the startAt and maxResults parameters to retrieve the first item in the results and define the maximum number of results returned per page. The corrected request should be as below :

      Request 
      
      http://host:port/context/rest/api-name/api-version/resource-name?startAt=0&maxResults=10 

      Actual Results

      The request in the REST API documentation contains start and limit parameters for pagination.

      Request 
      
      http://host:port/context/rest/api-name/api-version/resource-name?start=0&limit=10

      Steps to Reproduce

      NA

      Workaround

      Use startAt and maxResults parameters in the Jira REST API calls for pagination.

      http://host:port/context/rest/api-name/api-version/resource-name?startAt=0&maxResults=10  

            Assignee:
            Vasylyna Burger
            Reporter:
            Nitin Rastogi
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: