optimize api operation values
@@ -6,6 +6,7 @@ import greencity.constant.HttpStatuses;
import greencity.dto.habitfact.HabitFactDto;
import greencity.dto.habitfact.HabitFactPostDto;
import greencity.dto.language.LanguageTranslationDTO;
+import greencity.entity.Habit;
import greencity.entity.HabitFactTranslation;
import greencity.entity.HabitFact;
import greencity.service.HabitFactTranslationService;
@@ -41,10 +42,10 @@ public class HabitFactController {
private final ModelMapper mapper;
/**
- * The controller which returns random {@link HabitFact} by HabitDictionary factId.
+ * The controller which returns random {@link HabitFact} by {@link Habit} id.
*
- * @param habitId HabitDictionary
- * @return {@link HabitFactDto}
+ * @param habitId {@link Habit} id.
+ * @return {@link HabitFactDto}.
* @author Vitaliy Dzen
*/
@ApiOperation("Get random habit fact by habit id")
@@ -63,10 +64,10 @@ public class HabitFactController {
}
/**
- * The controller which return today's habitfact of the day.
+ * The controller which return today's {@link HabitFact} of the day.
*
- * @param languageId id of language to display the habitfact.
- * @return {@link LanguageTranslationDTO} of today's habitfact of the day.
+ * @param languageId id of language to display the {@link HabitFact}.
+ * @return {@link LanguageTranslationDTO} of today's {@link HabitFact} of the day.
*/
@ApiOperation("Get habit fact of the day")
@ApiResponses(value = {
@@ -86,7 +87,7 @@ public class HabitFactController {
/**
* The controller which returns all {@link HabitFact}.
*
- * @return List of {@link HabitFactDto}
+ * @return List of {@link HabitFactDto}.
* @author Vitaliy Dzen
*/
@ApiOperation("Get all facts")
@@ -104,8 +105,8 @@ public class HabitFactController {
/**
* The controller which save {@link HabitFact}.
*
- * @param fact {@link HabitFactPostDto}
- * @return {@link ResponseEntity}
+ * @param fact {@link HabitFactPostDto}.
+ * @return {@link ResponseEntity}.
* @author Vitaliy Dzen
*/
@ApiOperation(value = "Save habit fact")
@@ -124,9 +125,9 @@ public class HabitFactController {
/**
* The controller which update {@link HabitFact}.
*
- * @param dto {@link HabitFactPostDto}
- * @param factId of {@link HabitFact}
- * @return {@link ResponseEntity}
+ * @param dto {@link HabitFactPostDto}.
+ * @param factId of {@link HabitFact}.
+ * @return {@link ResponseEntity}.
* @author Vitaliy Dzen
*/
@ApiOperation(value = "Update habit fact")
@@ -146,8 +147,8 @@ public class HabitFactController {
/**
* The controller which delete {@link HabitFact}.
*
- * @param factId of {@link HabitFact}
- * @return {@link ResponseEntity}
+ * @param factId of {@link HabitFact}.
+ * @return {@link ResponseEntity}.
* @author Vitaliy Dzen
*/
@ApiOperation(value = "Delete habit fact")
