source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.v2.api.github.permissions.controller;
  21
  22 import io.swagger.v3.oas.annotations.Operation;
  23 import javax.validation.Valid;
  24 import org.sonar.server.v2.WebApiEndpoints;
  25 import org.sonar.server.v2.api.github.permissions.model.RestGithubPermissionsMapping;
  26 import org.sonar.server.v2.api.github.permissions.request.GithubPermissionMappingUpdateRequest;
  27 import org.sonar.server.v2.api.github.permissions.response.GithubPermissionsMappingRestResponse;
  28 import org.springframework.http.HttpStatus;
  29 import org.springframework.http.MediaType;
  30 import org.springframework.web.bind.annotation.DeleteMapping;
  31 import org.springframework.web.bind.annotation.GetMapping;
  32 import org.springframework.web.bind.annotation.PatchMapping;
  33 import org.springframework.web.bind.annotation.PathVariable;
  34 import org.springframework.web.bind.annotation.RequestBody;
  35 import org.springframework.web.bind.annotation.RequestMapping;
  36 import org.springframework.web.bind.annotation.ResponseStatus;
  37 import org.springframework.web.bind.annotation.RestController;
  38
  39 import static org.sonar.server.v2.WebApiEndpoints.JSON_MERGE_PATCH_CONTENT_TYPE;
  40
  41 @RequestMapping(WebApiEndpoints.GITHUB_PERMISSIONS_ENDPOINT)
  42 @RestController
  43 public interface GithubPermissionsController {
  44
  45   @GetMapping(produces = MediaType.APPLICATION_JSON_VALUE)
  46   @ResponseStatus(HttpStatus.OK)
  47   @Operation(summary = "Fetch the GitHub permissions mapping", description = "Requires Administer System permission.")
  48   GithubPermissionsMappingRestResponse fetchAll();
  49
  50   @PatchMapping(path = "/{githubRole}", consumes = JSON_MERGE_PATCH_CONTENT_TYPE, produces = MediaType.APPLICATION_JSON_VALUE)
  51   @ResponseStatus(HttpStatus.OK)
  52   @Operation(summary = "Update a single Github permission mapping", description = "Update a single Github permission mapping")
  53   RestGithubPermissionsMapping updateMapping(@PathVariable("githubRole") String githubRole, @Valid @RequestBody GithubPermissionMappingUpdateRequest request);
  54
  55   @DeleteMapping(path = "/{githubRole}")
  56   @ResponseStatus(HttpStatus.NO_CONTENT)
  57   @Operation(summary = "Delete a single Github permission mapping", description = "Delete a single Github permission mapping")
  58   void deleteMapping(@PathVariable("githubRole") String githubRole);
  59
  60 }