Uploaded image for project: 'SonarQube'
  1. SonarQube
  2. SONAR-11128

Add parameter metadata on the Web API page

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 7.4
    • Component/s: Documentation, Web
    • Labels:
      None
    • Edition:
      Community
    • Production Notes:
      None

      Description

      The following parameter metadata are not displayed in the Web API page :

      • minimum length : specify the minimum length of the value used in this parameter
      • maximum length : specify the maximum length of the value used in this parameter
      • maximum value : specify the maximum value of the numeric variable used in this parameter
      • maximum allowed values : specify the maximum number of values allowed when using a list of values

      Here are some example of the usage of these parameters :

      • In api/components/tree, q parameter has a minium length of 2 characters
      • In api/projects/create, project parameter has a maximum length of 400 characters
      • In api/project_tags/search, p parameter has a maximum value of 100
      • In api/projects/search, projects parameter has a maximum number of allowed values of 1000

        Attachments

          Activity

            People

            Assignee:
            stas.vilchik Stas Vilchik (Inactive)
            Reporter:
            julien.lancelot Julien Lancelot
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Due:
              Created:
              Updated:
              Resolved: