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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2024 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.request;
  21
  22 import io.swagger.v3.oas.annotations.media.Schema;
  23 import java.util.List;
  24 import javax.annotation.Nullable;
  25 import javax.validation.Valid;
  26 import javax.validation.constraints.NotEmpty;
  27 import javax.validation.constraints.NotNull;
  28 import javax.validation.constraints.Size;
  29 import org.sonar.server.v2.api.rule.enums.CleanCodeAttributeRestEnum;
  30 import org.sonar.server.v2.api.rule.enums.RuleStatusRestEnum;
  31 import org.sonar.server.v2.api.rule.resource.Impact;
  32 import org.sonar.server.v2.api.rule.resource.Parameter;
  33
  34 public record RuleCreateRestRequest(
  35
  36   @NotNull
  37   @Size(max = 200)
  38   @Schema(description = "Key of the custom rule to create, must include the repository")
  39   String key,
  40
  41   @NotNull
  42   @Size(max = 200)
  43   @Schema(description = "Key of the rule template to be used to create the custom rule")
  44   String templateKey,
  45
  46   @NotNull
  47   @Size(max = 200)
  48   @Schema(description = "Rule name")
  49   String name,
  50
  51   @NotNull
  52   @Schema(description = "Rule description in markdown format")
  53   String markdownDescription,
  54
  55   @Nullable
  56   @Schema(description = "Rule status", defaultValue = "READY")
  57   RuleStatusRestEnum status,
  58
  59   @Nullable
  60   @Schema(description = "Custom rule parameters")
  61   List<Parameter> parameters,
  62
  63   @NotNull
  64   @Schema(description = "Clean code attribute")
  65   CleanCodeAttributeRestEnum cleanCodeAttribute,
  66
  67   @Valid
  68   @NotEmpty
  69   @Schema(description = "Impacts")
  70   List<Impact> impacts
  71 ) {
  72 }