rethianita / spring-book

Undocumented declaration found JAVA-D1003
Documentation
Minor
14 occurrences in this check
Consider adding a doc comment for UserView
 1package io.example.domain.dto;
 2
 3public record UserView( 4  String id, 5 6  String username, 7  String fullName 8) { 910}
Consider adding a doc comment for UpdateUserRequest
 5import javax.validation.constraints.NotBlank;
 6import java.util.Set;
 7
 8public record UpdateUserRequest( 9  @NotBlank10  String fullName,11  Set<String> authorities12) {1314  @Builder15  public UpdateUserRequest {16  }1718  public UpdateUserRequest() {19    this(null, null);20  }21}
Consider adding a doc comment for SearchUsersQuery
 2
 3import lombok.Builder;
 4
 5public record SearchUsersQuery( 6  String id, 7  String username, 8  String fullName 9) {1011  @Builder12  public SearchUsersQuery {13  }1415  public SearchUsersQuery() {16    this(null, null, null);17  }18}
Consider adding a doc comment for SearchRequest
 3import javax.validation.Valid;
 4import javax.validation.constraints.NotNull;
 5
 6public record SearchRequest<T>( 7  @Valid 8  @NotNull 9  Page page,1011  @Valid12  @NotNull13  T query14) {1516  public SearchRequest {17  }1819  public SearchRequest(T query) {20    this(new Page(), query);21  }22}
Consider adding a doc comment for SearchBooksQuery
 6import java.time.LocalDateTime;
 7import java.util.Set;
 8
 9public record SearchBooksQuery(10  String id,1112  String creatorId,13  LocalDateTime createdAtStart,14  LocalDateTime createdAtEnd,1516  String title,17  Set<String> genres,18  String isbn13,19  String isbn10,20  String publisher,21  LocalDate publishDateStart,22  LocalDate publishDateEnd,2324  String authorId,25  String authorFullName26) {2728  @Builder29  public SearchBooksQuery {30  }3132  public SearchBooksQuery() {33    this(null, null, null, null, null, null, null, null, null, null, null, null, null);34  }35}
Consider adding a doc comment for SearchAuthorsQuery
 5import java.time.LocalDateTime;
 6import java.util.Set;
 7
 8public record SearchAuthorsQuery( 9  String id,1011  String creatorId,12  LocalDateTime createdAtStart,13  LocalDateTime createdAtEnd,1415  String fullName,16  Set<String> genres,1718  String bookId,19  String bookTitle20) {2122  @Builder23  public SearchAuthorsQuery {24  }2526  public SearchAuthorsQuery() {27    this(null, null, null, null, null, null, null, null);28  }29}
Consider adding a doc comment for Page
 3import javax.validation.constraints.Max;
 4import javax.validation.constraints.Min;
 5
 6public record Page( 7  @Min(value = 1, message = "Paging must start with page 1") long number, 8  @Min(value = 1, message = "You can request minimum 1 records") 9  @Max(value = 100, message = "You can request maximum 100 records") long limit) {1011  public Page() {12    this(1, 10);13  }14}
Consider adding a doc comment for ListResponse
 2
 3import java.util.List;
 4
 5public record ListResponse<T>( 6  List<T> items 7) { 8 9  public ListResponse {10  }1112  public ListResponse() {13    this(List.of());14  }15}
Consider adding a doc comment for EditBookRequest
 6import java.time.LocalDate;
 7import java.util.List;
 8
 9public record EditBookRequest(10  List<@NotNull String> authorIds,1112  @NotNull String title,13  String about,14  String language,15  List<String> genres,16  String isbn13,17  String isbn10,18  String publisher,19  LocalDate publishDate,20  Integer hardcover) {2122  @Builder23  public EditBookRequest {24  }2526  public EditBookRequest() {27    this(null, null, null, null, null, null, null, null, null, null);28  }29}
Consider adding a doc comment for EditAuthorRequest
 5import javax.validation.constraints.NotNull;
 6import java.util.List;
 7
 8public record EditAuthorRequest( 9  @NotNull String fullName,10  String about,11  String nationality,12  List<String> genres) {1314  @Builder15  public EditAuthorRequest {16  }1718  public EditAuthorRequest() {19    this(null, null, null, null);20  }21}
Consider adding a doc comment for CreateUserRequest
 5import java.util.HashSet;
 6import java.util.Set;
 7
 8public record CreateUserRequest( 9  @NotBlank @Email String username,10  @NotBlank String fullName,11  @NotBlank String password,12  @NotBlank String rePassword,13  Set<String> authorities) {1415  public CreateUserRequest {16    if (authorities == null) {17      authorities = new HashSet<>();18    }19  }2021  public CreateUserRequest(22    String username,23    String fullName,24    String password,25    String rePassword26  ) {27    this(username, fullName, password, rePassword, new HashSet<>());28  }2930  public CreateUserRequest(31    String username,32    String fullName,33    String password34  ) {35    this(username, fullName, password, password, new HashSet<>());36  }37}
Consider adding a doc comment for BookView
 4import java.time.LocalDateTime;
 5import java.util.List;
 6
 7public record BookView( 8  String id, 910  UserView creator,11  LocalDateTime createdAt,1213  String title,14  String about,15  String language,16  List<String> genres,17  String isbn13,18  String isbn10,19  String publisher,20  LocalDate publishDate,21  int hardcover) {2223}
Consider adding a doc comment for AuthorView
 3import java.time.LocalDateTime;
 4import java.util.List;
 5
 6public record AuthorView( 7  String id, 8 9  UserView creator,10  LocalDateTime createdAt,1112  String fullName,13  String about,14  String nationality,15  List<String> genres16) {1718}
Consider adding a doc comment for AuthRequest
 3import javax.validation.constraints.Email;
 4import javax.validation.constraints.NotNull;
 5
 6public record AuthRequest( 7  @NotNull @Email String username, 8  @NotNull String password) { 910  public AuthRequest() {11    this(null, null);12  }13}