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

Modify WS to return plugin's documentation path

    XMLWordPrintable

    Details

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

      Description

      Plugins can ship with static files inside their static/ folder. Since MMF-1668, the front-end relies on several of these files for documentation.

      We will modify an api/plugins/installed WS, so that it will return additional field documentationPath, which is path to documentation within plugin jar file. The payload after modification will look like this:

      {
        "plugins": [
          {
            "key": "ldap",
            "name": "LDAP",
            "description": "Delegates authentication to LDAP",
            "version": "2.2 (build 608)",
            "license": "GNU LGPL 3",
            "organizationName": "SonarSource",
            "organizationUrl": "https://www.sonarsource.com",
            "editionBundled": false,
            "homepageUrl": "http://redirect.sonarsource.com/plugins/ldap.html/sonar-ldap-plugin",
            "issueTrackerUrl": "http://jira.sonarsource.com/browse/LDAP",
            "implementationBuild": "79dc3fa4393a29667673c70182f3016288b548b7",
            "documentationPath": "static/documentation.md",
            "updatedAt": 1564562773838,
            "filename": "sonar-ldap-plugin-2.2.0.608.jar",
            "sonarLintSupported": false,
            "hash": "90da8f56fbbbb3624b8a3f6f1075860a"
          },
          {
            "key": "authsaml",
            "name": "SAML 2.0 Authentication for SonarQube",
            "description": "SAML 2.0 Authentication for SonarQube",
            "version": "1.1.0 (build 181)",
            "license": "GNU LGPL 3",
            "organizationName": "SonarSource",
            "organizationUrl": "http://www.sonarsource.com",
            "editionBundled": false,
            "homepageUrl": "http://redirect.sonarsource.com/plugins/authsaml.html",
            "issueTrackerUrl": "https://jira.sonarsource.com/browse/SQAUTHSAML",
            "implementationBuild": "16fcb5be2d3bcfee8920b29cd758d8b957a18acb",
            "updatedAt": 1564562773838,
            "filename": "sonar-auth-saml-plugin-1.1.0.181.jar",
            "sonarLintSupported": false,
            "hash": "cb2c8bc61a566b6f9bd7f4a8d9518a25"
          },
          {
            "key": "csharp",
            "name": "SonarC#",
            "description": "Code Analyzer for C#",
            "version": "7.16 (build 8759)",
            "license": "GNU LGPL 3",
            "organizationName": "SonarSource",
            "organizationUrl": "http://www.sonarsource.com",
            "editionBundled": false,
            "homepageUrl": "http://redirect.sonarsource.com/plugins/csharp.html",
            "issueTrackerUrl": "https://github.com/SonarSource/sonar-dotnet/issues",
            "implementationBuild": "1623211b656a3f9ae4c4d96245c7f3d72131a6ab",
            "documentationPath": "static/documentation.md",
            "updatedAt": 1564562773838,
            "filename": "sonar-csharp-plugin-7.16.0.8759.jar",
            "sonarLintSupported": false,
            "hash": "9b2bb72ef1a6d5a79293eadbb2b0b81a"
          }
        ]
      }
      
      

       

      In case there is no documentation.md file spotted inside jar file field will not be returned.

       

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jacek.poreda Jacek Poreda
              Reporter:
              wouter.admiraal Wouter Admiraal
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Due:
                Created:
                Updated:
                Resolved: