all

Get All Reviews

This endpoint retrieves a list of reviews with pagination.

Request

• Method: GET
• Endpoint: {{baseUrl}}/reviews/all
• Query Parameters:
  • page (integer, required): The page number to retrieve.
  • limit (integer, required): The number of reviews per page.

Response The response will contain an object with the following properties:

• data (object): The data container.

  • reviews (object): The reviews container.
    • docs (array): An array of review objects containing the following fields:
      • _id (string): The unique identifier of the review.
      • book (string): The book being reviewed.
      • review (string): The review content.
      • reviewer (string): The reviewer’s name.
      • rating (integer): The rating given to the book.
      • upvoters (array): An array of upvoter IDs.
      • downvoters (array): An array of downvoter IDs.
      • isRemoved (boolean): Indicates if the review has been removed.
      • createdAt (string): The creation date of the review.
      • updatedAt (string): The last update date of the review.
      • __v (integer): Version key.
    • totalDocs (integer): The total number of reviews.
    • offset (integer): The offset of the current page.
    • limit (integer): The limit of reviews per page.
    • totalPages (integer): The total number of pages.
    • page (integer): The current page number.
    • pagingCounter (integer): The paging counter.
    • hasPrevPage (boolean): Indicates if there is a previous page.
    • hasNextPage (boolean): Indicates if there is a next page.
    • prevPage (null): The previous page number.
    • nextPage (null): The next page number.

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

GET /reviews/all

all

cURL

curl --request GET \
  --url http://localhost:8000/v1/reviews/all

200

{
  "data": {
    "reviews": {
      "docs": [
        {
          "__v": 0,
          "_id": "670e317b59f06fc0a2501117",
          "book": "670e2ce78296c4aa4d1374ad",
          "createdAt": "2024-10-15T09:10:19.964Z",
          "downvoters": [],
          "isRemoved": false,
          "rating": 4,
          "review": "A great book, Gilead.",
          "reviewer": "6708d54f9c193b2aeae09b80",
          "updatedAt": "2024-10-15T09:10:19.964Z",
          "upvoters": []
        }
      ],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 1,
      "totalPages": 1
    }
  },
  "error": null
}

Query Parameters

page · string

Example:

"1"

limit · string

Example:

"10"

Response

200

application/json

all - success

data · object

Show child attributes

error · unknown