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

missing WEB API response example on several endpoints

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Web API
    • Labels:
      None
    • Edition:
      Community
    • Production Notes:
      None

      Description

      At startup SonarQube yells theses warning:

      WARN The response example is not set on action api/plugins/download
      WARN The response example is not set on action api/permissions/search_templates
      WARN The response example is not set on action api/alm_integrations/list_bitbucketserver_projects
      WARN The response example is not set on action api/alm_integrations/search_bitbucketserver_repos
      WARN The response example is not set on action api/alm_integrations/list_github_organizations
      WARN The response example is not set on action api/alm_integrations/list_github_repositories
      WARN The response example is not set on action api/alm_integrations/check_pat
      WARN The response example is not set on action api/alm_integrations/get_github_client_id
      WARN The response example is not set on action api/security_reports/show

       

      Theses endpoint should include payload example, to keep the WEB API great

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              pierre.guillot Pierre Guillot
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: