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.rule.controller;
  21
  22 import io.swagger.v3.oas.annotations.Operation;
  23 import javax.validation.Valid;
  24 import org.sonar.server.v2.api.rule.request.RuleCreateRestRequest;
  25 import org.sonar.server.v2.api.rule.response.RuleRestResponse;
  26 import org.springframework.http.HttpStatus;
  27 import org.springframework.http.MediaType;
  28 import org.springframework.web.bind.annotation.PostMapping;
  29 import org.springframework.web.bind.annotation.RequestBody;
  30 import org.springframework.web.bind.annotation.RequestMapping;
  31 import org.springframework.web.bind.annotation.ResponseStatus;
  32 import org.springframework.web.bind.annotation.RestController;
  33
  34 import static org.sonar.server.v2.WebApiEndpoints.RULES_ENDPOINT;
  35
  36 @RequestMapping(RULES_ENDPOINT)
  37 @RestController
  38 public interface RuleController {
  39
  40   @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
  41   @ResponseStatus(HttpStatus.OK)
  42   @Operation(summary = "Create a rule", description = """
  43       Create a rule
  44     """)
  45     //TODO Document
  46   RuleRestResponse create(@Valid @RequestBody RuleCreateRestRequest request);
  47
  48 }