Package com.patreonshout.rest.interfaces

Interface TagImpl

All Known Implementing Classes:
TagSvc
@RequestMapping("/tags")
public interface TagImpl
Interface for endpoints relating to lists

  • Method Summary

    Modifier and Type Method Description
    org.springframework.http.ResponseEntity<?> AddTag​(TagAddRequest tagAddRequest)
    Endpoint that will add a new Tag object to the database
    org.springframework.http.ResponseEntity<?> DeleteUserTagOnSinglePost​(TagDeleteRequest tagDeleteRequest)
    Endpoint that will delete the user given tag of a post from the database
    org.springframework.http.ResponseEntity<?> GetUserTagsOnSinglePost​(TagGetRequest tagGetRequest)
    Endpoint that will get the user given tags of a post from the database

  • Method Details

    • AddTag

      @PostMapping org.springframework.http.ResponseEntity<?> AddTag​(@RequestBody TagAddRequest tagAddRequest) throws PSException
      Endpoint that will add a new Tag object to the database
      Parameters:
      tagAddRequest - is the TagAddRequest object that contains Tag request parameters
      Returns:
      HttpStatus.CREATED if successful, HttpStatus.CONFLICT or HttpStatus.INTERNAL_SERVER_ERROR or HttpStatus.BAD_GATEWAY otherwise
      Throws:
      PSException

    • GetUserTagsOnSinglePost

      @GetMapping org.springframework.http.ResponseEntity<?> GetUserTagsOnSinglePost​(@RequestBody TagGetRequest tagGetRequest) throws PSException
      Endpoint that will get the user given tags of a post from the database
      Parameters:
      tagGetRequest - is the TagGetRequest object that contains Tag request parameters
      Returns:
      HttpStatus.CREATED if successful, HttpStatus.INTERNAL_SERVER_ERROR or HttpStatus.BAD_GATEWAY otherwise
      Throws:
      PSException

    • DeleteUserTagOnSinglePost

      @DeleteMapping org.springframework.http.ResponseEntity<?> DeleteUserTagOnSinglePost​(@RequestBody TagDeleteRequest tagDeleteRequest) throws PSException
      Endpoint that will delete the user given tag of a post from the database
      Parameters:
      tagDeleteRequest - is the TagDeleteRequest object that contains Tag request parameters
      Returns:
      HttpStatus.CREATED if successful, HttpStatus.INTERNAL_SERVER_ERROR or HttpStatus.BAD_GATEWAY otherwise
      Throws:
      PSException