Details

    • Type: IDEA
    • Status: In Specification
    • Priority: Major
    • Resolution: Unresolved
    • Labels:

      Description

      Use cases

      As a SonarCloud user, when browsing the Web API:

      • I don't care in which version of SonarQube an API was introduced
      • I don't care in which versions changes were done, but I might want to know if those changes are recent or old
      • I want to see the org-related parameters by default w/o having to click on "Show Internal API"
      • I should not see the Billing WS

      As a SonarQube user, when browsing the Web API:

      • I should not see the org-related parameters as long as orgs are not activated (feature that is currently not officially supported on SonarQube)
      • I should not see the branch-related parameters as long as branch support is not activated (feature that is currently not available)

      Solutions

      • When deployed on SonarCloud (controlled thanks to the dedicated parameter):
        • Don't display WS related to Billing (api/billing and api/billing_center)
        • Remove the version in which a WS API was introduced
        • In the changelog, replace the versions by dates
          • The date set in the changelog can be the date of the end of sprint in which this change was done
      • Remove the "Internal" flag on every WS or WS param related to organization (unless it's really supposed to be internal - which is often for UI-only WS)
      • Implement a mechanism that allows:
        • When orgs are not activated, to never display the corresponding WS or WS params
        • When branches are not activated, to never display the corresponding WS or WS params

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                fabrice.bellingard Fabrice Bellingard
                Reporter:
                fabrice.bellingard Fabrice Bellingard
              • Votes:
                3 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated: