endpoints summary

Author: purshink

react-frontend/src/components/root/users/login/forgottenPassword/PasswordChange.jsx

@@ -103,7 +103,7 @@ const PasswordChange = () => {
           )}
         </form>
       </main>
-      <Footer class={style.footer} />
+      <Footer class={style.footer_cover} />
       <Background />
     </>
   );

react-frontend/src/components/root/users/login/forgottenPassword/SetUpNewPassword.jsx

@@ -114,7 +114,7 @@ const SetUpNewPassword = () => {
           </div>
         </form>
       </main>
-      <Footer class={style.footer} />
+      <Footer class={style.footer_cover} />
       <Background />
     </>
   );

spring-backend/src/main/java/backend/hobbiebackend/model/entities/Hobby.java

@@ -23,16 +23,12 @@ public class Hobby extends BaseEntity{
     private String galleryImg1_id;
     private String galleryImg2_id;
     private String galleryImg3_id;
-
     private String contactInfo;
 
-    //TODO HOBBY ADDRESS
-
-
-
 
     public Hobby() {
     }
+    
     @Column(name = "profile_img_id")
     public String getProfileImg_id() {
         return profileImg_id;

spring-backend/src/main/java/backend/hobbiebackend/service/impl/HobbyServiceImpl.java

@@ -83,13 +83,13 @@ public boolean deleteHobby(long id) throws Exception {
     }
 
     private void deleteResourcesById(Hobby byId) throws Exception {
-        String profileImgUrl = byId.getProfileImg_id();
-        String galleryImgUrl1 = byId.getGalleryImg1_id();
-        String galleryImgUrl2 = byId.getGalleryImg2_id();
-        String galleryImgUrl3 = byId.getGalleryImg3_id();
+        String profileImgId = byId.getProfileImg_id();
+        String galleryImgId1 = byId.getGalleryImg1_id();
+        String galleryImgId2 = byId.getGalleryImg2_id();
+        String galleryImgId3 = byId.getGalleryImg3_id();
 
 
-        cloudinary.api().deleteResources(Arrays.asList(profileImgUrl, galleryImgUrl1,galleryImgUrl2,galleryImgUrl3),
+        cloudinary.api().deleteResources(Arrays.asList(profileImgId, galleryImgId1,galleryImgId2,galleryImgId3),
                 Map.of("invalidate", true ));
 
     }

spring-backend/src/main/java/backend/hobbiebackend/web/HobbyController.java

@@ -50,6 +50,7 @@ public HobbyController(HobbyService hobbyService, CategoryService categoryServic
 
 
     @PostMapping
+    @Operation(summary = "Create new hobby", security = @SecurityRequirement(name = "bearerAuth"))
     public  ResponseEntity<HttpStatus> saveHobby(@RequestBody HobbyInfoDto info){
 
         Hobby offer = this.modelMapper.map(info, Hobby.class);
@@ -70,21 +71,21 @@ public  ResponseEntity<HttpStatus> saveHobby(@RequestBody HobbyInfoDto info){
     }
 
     @GetMapping(value ="/is-saved")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Show if hobby is saved in favorites", security = @SecurityRequirement(name = "bearerAuth"))
     public boolean isHobbySaved(@RequestParam Long id, @RequestParam String username){
         return  this.hobbyService.isHobbySaved(id, username);
     }
 
     @GetMapping(value ="/{id}")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Show hobby details", security = @SecurityRequirement(name = "bearerAuth"))
     public Hobby getHobbyDetails(@PathVariable Long id){
 
       return  this.hobbyService.findHobbieById(id);
     }
 
 
     @PostMapping ("/save")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Save hobby in favorites", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<Long> save(@RequestParam Long id, @RequestParam String username){
         Hobby hobby = this.hobbyService.findHobbieById(id);
 
@@ -99,7 +100,7 @@ public ResponseEntity<Long> save(@RequestParam Long id, @RequestParam String use
     }
 
     @DeleteMapping("/remove")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Remove hobby from favorites", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<Long> removeHobby(@RequestParam Long id, @RequestParam String username){
 
         Hobby hobby = this.hobbyService.findHobbieById(id);
@@ -115,7 +116,7 @@ public ResponseEntity<Long> removeHobby(@RequestParam Long id, @RequestParam Str
 
 
     @PutMapping
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Update hobby,(use existing hobby id)", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<?> updateHobby(@RequestBody HobbyInfoUpdateDto info) throws Exception {
         Hobby offer = this.modelMapper.map(info, Hobby.class);
         Category category = this.categoryService.findByName(info.getCategory());
@@ -128,7 +129,7 @@ public ResponseEntity<?> updateHobby(@RequestBody HobbyInfoUpdateDto info) throw
     }
 
     @DeleteMapping("/{id}")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Delete hobby", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<Long> deleteHobby(@PathVariable Long id) throws Exception {
         boolean isRemoved = this.hobbyService.deleteHobby(id);
 
@@ -139,7 +140,7 @@ public ResponseEntity<Long> deleteHobby(@PathVariable Long id) throws Exception
     }
 
     @GetMapping("/saved")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Show hobbies that are saved in favorites", security = @SecurityRequirement(name = "bearerAuth"))
     public List<Hobby> savedHobbies(@RequestParam String username)  {
         AppClient appClient = this.userService.findAppClientByUsername(username);
         return this.hobbyService.findSavedHobbies(appClient);

spring-backend/src/main/java/backend/hobbiebackend/web/HomeController.java

@@ -30,7 +30,7 @@ public HomeController(HobbyService hobbyService) {
     }
 
     @GetMapping( "/home")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Show client/business homepage", security = @SecurityRequirement(name = "bearerAuth"))
     public Set<Hobby> hobbiesShow(@RequestParam String username,@RequestParam String role) {
 
         if(role.equals("user")){

spring-backend/src/main/java/backend/hobbiebackend/web/TestController.java

@@ -27,7 +27,7 @@ public TestController(TestService testService) {
 
 
     @PostMapping("/test")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Save test results", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<HttpStatus> saveTestResults(@RequestBody Test results) {
         this.testService.saveTestResults(results);
         return new ResponseEntity<>(HttpStatus.CREATED);

spring-backend/src/main/java/backend/hobbiebackend/web/UserController.java

@@ -58,6 +58,7 @@ public UserController(UserService userService, PasswordEncoder passwordEncoder,
 
 
     @PostMapping("/signup")
+    @Operation(summary = "Create new client-user")
     public ResponseEntity<?> signup(@RequestBody AppClientSignUpDto user){
         System.out.println(user);
 
@@ -71,6 +72,7 @@ public ResponseEntity<?> signup(@RequestBody AppClientSignUpDto user){
 
 
     @PostMapping("/register")
+    @Operation(summary = "Create new business-user")
     public ResponseEntity<?> registerBusiness(@RequestBody BusinessRegisterDto business){
 
         if(this.userService.businessExists(business.getBusinessName() ) || this.userService.userExists(business.getUsername(), business.getEmail())){
@@ -86,20 +88,20 @@ public ResponseEntity<?> registerBusiness(@RequestBody BusinessRegisterDto busin
 
 
     @GetMapping("/client")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "show client-user information", security = @SecurityRequirement(name = "bearerAuth"))
     public AppClient showUserDetails(@RequestParam String username) {
             return  this.userService.findAppClientByUsername(username);
     }
 
 
     @GetMapping("/business")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Show business-user information", security = @SecurityRequirement(name = "bearerAuth"))
     public BusinessOwner showBusinessDetails(@RequestParam String username)  {
         return  this.userService.findBusinessByUsername(username);
     }
 
     @PutMapping("/user")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Update client-user information (use existing user id)", security = @SecurityRequirement(name = "bearerAuth"))
         public ResponseEntity<?>  updateUser(@RequestBody UpdateAppClientDto user) {
 
                     AppClient client = this.userService.findAppClientById(user.getId());
@@ -113,7 +115,7 @@ public ResponseEntity<?>  updateUser(@RequestBody UpdateAppClientDto user) {
 
     }
     @PostMapping ("/notification")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Send notification with password reset link", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<?>  sendNotification(@RequestParam("email")  String e) {
         UserEntity userByEmail = this.userService.findUserByEmail(e);
 
@@ -125,8 +127,8 @@ public ResponseEntity<?>  sendNotification(@RequestParam("email")  String e) {
         }
         return new ResponseEntity<>(userByEmail, HttpStatus.OK);
     }
-    @PostMapping("/password")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @PutMapping("/password")
+    @Operation(summary = "Update password, (use existing user id)", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<?>  setUpNewPassword(@RequestParam Long id, String password) {
         UserEntity userById = this.userService.findUserById(id);
         userById.setPassword(this.passwordEncoder.encode(password));
@@ -135,7 +137,7 @@ public ResponseEntity<?>  setUpNewPassword(@RequestParam Long id, String passwor
     }
 
     @PutMapping("/business")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Update business-user, (use existing user id)", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<?>  updateBusiness(@RequestBody UpdateBusinessDto business) {
 
         BusinessOwner businessOwner = this.userService.findBusinessOwnerById(business.getId());
@@ -151,7 +153,7 @@ public ResponseEntity<?>  updateBusiness(@RequestBody UpdateBusinessDto business
 
     }
     @DeleteMapping("/user/{id}")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Delete user", security = @SecurityRequirement(name = "bearerAuth"))
     public ResponseEntity<Long> deleteUser(@PathVariable Long id){
 
         boolean isRemoved = this.userService.deleteUser(id);
@@ -163,6 +165,7 @@ public ResponseEntity<Long> deleteUser(@PathVariable Long id){
     }
 
     @PostMapping("/authenticate")
+    @Operation(summary = "Authenticate user and get JWT Token")
     public JwtResponse authenticate(@RequestBody JwtRequest jwtRequest) throws Exception{
 
         try {
@@ -188,7 +191,7 @@ public JwtResponse authenticate(@RequestBody JwtRequest jwtRequest) throws Excep
 
     @PostMapping("/login")
     @CrossOrigin(origins = "http://localhost:4200")
-    @Operation(summary = "My endpoint", security = @SecurityRequirement(name = "bearerAuth"))
+    @Operation(summary = "Login based on user role after authentication", security = @SecurityRequirement(name = "bearerAuth"))
     public String logInUser(@RequestParam String username){
         UserEntity userByUsername = this.userService.findUserByUsername(username);
         if (userByUsername.getRoles().stream()