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

Improvements to the REST doc of /search-v1/crossRepositoryQuery

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Fixed
    • 3.6.0
    • Documentation
    • None
    • 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

      The documentation for /rest-service-fe/search-v1/crossRepositoryQuery (which is used by the JIRA-FishEye plugin) needs improvements:

      • the parameter expand which is used to specify the scope of the request is required and undocumented (sample value in practise: "expand=changesets[0:20].revisions[0:30],reviews");
      • the response' s examples are completely wrong. As an example, this is a typical response received by the plugin:
        <?xml version="1.0" encoding="UTF-8"?>
        <results expand="changesets">
          <changesets>
            <changeset>
              <repositoryName>testrepo1</repositoryName>
              <csid>3db01b0a40e7e6b49e0cd3a59fc0e2ebea469f19</csid>
              <date>2013-05-16T17:24:13+10:00</date>
              <author>Pierre-Etienne Poirot &lt;pepoirot@atlassian.com&gt;</author>
              <branch>master</branch>
              <comment>MKY-3: abc (CR-1 review)
        </comment>
              <revisions size="1">
                <revision totalLines="2" fileRevisionState="CHANGED" rev="3db01b0a40e7e6b49e0cd3a59fc0e2ebea469f19" path="test" linesRemoved="0" linesAdded="1" date="2013-05-16T17:24:13+10:00" csid="3db01b0a40e7e6b49e0cd3a59fc0e2ebea469f19" contentLink="/browse/~raw,r=3db01b0a40e7e6b49e0cd3a59fc0e2ebea469f19/testrepo1/test" author="Pierre-Etienne Poirot &lt;pepoirot@atlassian.com&gt;" ancestor="5f9a25114754fb33f3971414f7cd6edcdbb8989c">
                  <ancestor>5f9a25114754fb33f3971414f7cd6edcdbb8989c</ancestor>
                  <comment>MKY-3: abc (CR-1 review)
        </comment>
                </revision>
              </revisions>
              <reviews size="1">
                <review>
                  <description>{cs:id=3db01b0a40e7e6b49e0cd3a59fc0e2ebea469f19|rep=testrepo1}: MKY-3: abc (CR-1 review)</description>
                  <metricsVersion>0</metricsVersion>
                  <name>MKY-3: abc (CR-1 review)</name>
                  <permaId>
                    <id>CR-1</id>
                  </permaId>
                  <permaIdHistory>CR-1</permaIdHistory>
                  <state>Review</state>
                </review>
              </reviews>
            </changeset>
          </changesets>
        </results>
        

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              pepoirot Pierre-Etienne Poirot (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - Not Specified
                  Not Specified
                  Logged:
                  Time Spent - 37m
                  37m