Uploaded image for project: 'FishEye'
  1. FishEye
  2. FE-555

Documentation: Add maxReturn parameter to remote API

    XMLWordPrintable

Details

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      Need to update http://confluence.atlassian.com/display/FISHEYE/The+FishEye+Remote+API with the new maxReturn clause added to the List Changesets method.

      Changesets listChangesets(String auth, String rep, String path, Date start=null, Date end=null)
      

      should be updated to:

      Changesets listChangesets(String auth, String rep, String path, Date start=null, Date end=null, int maxReturn)
      

      and

      Changesets listChangesets(String auth, String rep, String path)
          Changesets listChangesets(String auth, String rep, String path, Date start)
          Changesets listChangesets(String auth, String rep, String path, Date start, Date end)
      

      should be updated to:

      Changesets listChangesets(String auth, String rep, String path)
          Changesets listChangesets(String auth, String rep, String path, Date start)
          Changesets listChangesets(String auth, String rep, String path, Date start, Date end)
          Changesets listChangesets(String auth, String rep, String path, Date start, Date end, int maxReturn)
      

      and

      FishEye has an internal limit of how many changesets it will return from this method (a few thousand). If this limit is exceeded, the return value will be truncated so that it contains the most-recent changesets. This value of this limit is contained in the return value. 
      

      should be changed to something similar to:

      The maxReturn clause limits the number of changesets returned by this method. If no limit is specified, FishEye will use its own internal limit  (a few thousand). If this limit is exceeded, the return value will be truncated so that it contains the most-recent changesets. The value of this limit is contained in the returned data structure. 
      

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              tim@atlassian.com TimP
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: