Added docs for new added functions on Backend

This commit is contained in:
2023-05-19 13:06:18 +02:00
parent bddd7e9b0d
commit ee4bf321f9
6 changed files with 31 additions and 1 deletions

View File

@@ -12,6 +12,12 @@ import org.springframework.scheduling.annotation.Scheduled;
import java.time.LocalDateTime; import java.time.LocalDateTime;
/**
* Based on configuration deletes all outdated messages and history records from database.
*
* @author Mikołaj Widła
*/
@EnableScheduling @EnableScheduling
@EnableAsync @EnableAsync
@Configuration @Configuration

View File

@@ -9,6 +9,12 @@ import org.springframework.context.annotation.Configuration;
import javax.validation.constraints.Positive; import javax.validation.constraints.Positive;
/**
* Store all properties needed to change a retention in {@link RetentionConfiguration}
*
* @author Mikołaj Widła
*/
@Configuration @Configuration
@ConfigurationProperties(prefix = "retention") @ConfigurationProperties(prefix = "retention")
@Getter @Getter

View File

@@ -6,6 +6,12 @@ import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* Configuration for {@link IncomingMockRequestInterceptor}
*
* @author Mikołaj Widła
*/
@Configuration @Configuration
@AllArgsConstructor @AllArgsConstructor
public class WebConfig implements WebMvcConfigurer{ public class WebConfig implements WebMvcConfigurer{

View File

@@ -5,6 +5,13 @@ import com.r11.tools.model.RequestHistoryDTO;
import org.mapstruct.Mapper; import org.mapstruct.Mapper;
import org.mapstruct.Mapping; import org.mapstruct.Mapping;
/**
* Map between DTO and Entity
*
* @author Mikołaj Widła
*
*/
@Mapper @Mapper
public interface RequestHistoryMapper { public interface RequestHistoryMapper {

View File

@@ -9,6 +9,11 @@ import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime; import java.time.LocalDateTime;
import java.util.UUID; import java.util.UUID;
/**
* Represents all data needed to get HistoryRecord from database
* @author Mikołaj Widła
*/
@Data @Data
@Builder @Builder
@NoArgsConstructor @NoArgsConstructor

View File

@@ -8,7 +8,7 @@ import org.springframework.transaction.annotation.Transactional;
import java.util.List; import java.util.List;
/** /**
* Event entity dao interface * History Record entity dao interface
* @author Rafał Żukowicz * @author Rafał Żukowicz
*/ */
@Repository @Repository