upvote

Upvote a Review

This endpoint allows users to upvote a specific review by sending an HTTP PATCH request to the specified URL. The request should include the review ID in the URL path. Upon successful execution, the response will include the updated review data along with any errors.

Request Body

This request does not require a request body.

Response Body

• data (object)

  • updatedReview (object)

    • _id (string): The ID of the updated review.

    • book (string): The book associated with the review.

    • review (string): The content of the review.

    • reviewer (string): The reviewer of the review.

    • rating (number): The rating given to the book.

    • upvoters (array): List of users who upvoted the review.

    • downvoters (array): List of users who downvoted the review.

    • isRemoved (boolean): Indicates whether the review is removed.

    • createdAt (string): The timestamp of review creation.

    • updatedAt (string): The timestamp of review update.

    • __v (number): Version key.

• error (null): If there are any errors, they will be included here.

PATCH /reviews/{reviewId}/upvote

upvote

cURL

curl --request PATCH \
  --url http://localhost:8000/v1/reviews/{reviewId}/upvote

200

{
  "data": {
    "updatedReview": {
      "__v": 0,
      "_id": "670c3a4ede2e2e9ee7d34d0f",
      "book": "670bcc0569f877ed50dfacdf",
      "createdAt": "2024-10-13T21:23:26.026Z",
      "downvoters": [],
      "isRemoved": false,
      "rating": 3,
      "review": "A great book, Gilead.",
      "reviewer": "670c22148db1109908c9f6b9",
      "updatedAt": "2024-10-14T12:57:52.791Z",
      "upvoters": [
        "670c22148db1109908c9f6b9"
      ]
    }
  },
  "error": null
}

Path Parameters

reviewId · string · required

Example:

"670c3a4ede2e2e9ee7d34d0f"

Response

200 - application/json

upvote - success

data · object

Show child attributes

error · unknown