]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-20635 Clarify endpoint description to import projects from DevOps Platform
authorAntoine Vigneau <antoine.vigneau@sonarsource.com>
Mon, 2 Oct 2023 15:06:11 +0000 (17:06 +0200)
committersonartech <sonartech@sonarsource.com>
Wed, 4 Oct 2023 20:03:19 +0000 (20:03 +0000)
server/sonar-webserver-webapi/src/main/java/org/sonar/server/almintegration/ws/github/ImportGithubProjectAction.java
server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/CreateAction.java

index 3a6db7a1345e6ab5597180af42111840377fde8b..c621b028f6e7a0bcae35cfd62d68529187579865 100644 (file)
@@ -108,7 +108,7 @@ public class ImportGithubProjectAction implements AlmIntegrationsWsAction {
   public void define(WebService.NewController context) {
     WebService.NewAction action = context.createAction("import_github_project")
       .setDescription("Create a SonarQube project with the information from the provided GitHub repository.<br/>" +
-        "Autoconfigure pull request decoration mechanism.<br/>" +
+        "Autoconfigure pull request decoration mechanism. If Automatic Provisioning is enable for GitHub, it will also synchronize permissions from the repository.<br/>" +
         "Requires the 'Create Projects' permission")
       .setPost(true)
       .setSince("8.4")
index 1eddb0b29fe82b6f4373b5bbcae99742e31f2f97..6b3409d0e41925479690f0dfb600bdc394633e40 100644 (file)
@@ -84,7 +84,8 @@ public class CreateAction implements ProjectsWsAction {
   public void define(WebService.NewController context) {
     WebService.NewAction action = context.createAction(ACTION_CREATE)
       .setDescription("Create a project.<br/>" +
-        "Requires 'Create Projects' permission")
+        "If your project is hosted on a DevOps Platform, please use the import endpoint under api/alm_integrations, so it creates and properly configures the project." +
+        "Requires 'Create Projects' permission.<br/>")
       .setSince("4.0")
       .setPost(true)
       .setResponseExample(getClass().getResource("create-example.json"))