get all

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

{
  "data": {
    "interests": {
      "docs": [
        {
          "__v": 0,
          "_id": "670e151986ced1463b2b60be",
          "createdAt": "2024-10-15T07:09:13.920Z",
          "genre": {
            "_id": "670e14f586ced1463b2b60bc",
            "name": "Fiction"
          },
          "updatedAt": "2024-10-15T07:09:13.920Z",
          "user": {
            "__v": 0,
            "_id": "6708d54f9c193b2aeae09b80",
            "createdAt": "2024-10-11T07:35:43.468Z",
            "email": "abebe@gmail.com",
            "firstName": "abebebch",
            "lastName": "kebede",
            "role": "user",
            "updatedAt": "2024-10-15T08:49:39.357Z",
            "userName": "abebekebede1"
          }
        }
      ],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 1,
      "totalPages": 1
    }
  },
  "error": null
}

Interest

get all

Get all Interests

The endpoint makes an HTTP GET request to retrieve a list of interests with pagination. The request includes the page number and the limit of interests per page.

The response for this request can be documented as a JSON schema as follows:

{
    "type": "object",
    "properties": {
        "data": {
            "type": "object",
            "properties": {
                "interests": {
                    "type": "object",
                    "properties": {
                        "docs": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "_id": {"type": "string"},
                                    "user": {
                                        "type": "object",
                                        "properties": {
                                            "_id": {"type": "string"},
                                            "firstName": {"type": "string"},
                                            "lastName": {"type": "string"},
                                            "userName": {"type": "string"},
                                            "email": {"type": "string"},
                                            "role": {"type": "string"},
                                            "createdAt": {"type": "string"},
                                            "updatedAt": {"type": "string"},
                                            "__v": {"type": "integer"}
                                        }
                                    },
                                    "genre": {
                                        "type": "object",
                                        "properties": {
                                            "_id": {"type": "string"},
                                            "name": {"type": "string"}
                                        }
                                    },
                                    "createdAt": {"type": "string"},
                                    "updatedAt": {"type": "string"},
                                    "__v": {"type": "integer"}
                                }
                            }
                        },
                        "totalDocs": {"type": "integer"},
                        "offset": {"type": "integer"},
                        "limit": {"type": "integer"},
                        "totalPages": {"type": "integer"},
                        "page": {"type": "integer"},
                        "pagingCounter": {"type": "integer"},
                        "hasPrevPage": {"type": "boolean"},
                        "hasNextPage": {"type": "boolean"},
                        "prevPage": {"type": "null"},
                        "nextPage": {"type": "null"}
                    }
                },
                "error": {"type": "null"}
            }
        }
    }
}

GET

interests

all

get all

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

{
  "data": {
    "interests": {
      "docs": [
        {
          "__v": 0,
          "_id": "670e151986ced1463b2b60be",
          "createdAt": "2024-10-15T07:09:13.920Z",
          "genre": {
            "_id": "670e14f586ced1463b2b60bc",
            "name": "Fiction"
          },
          "updatedAt": "2024-10-15T07:09:13.920Z",
          "user": {
            "__v": 0,
            "_id": "6708d54f9c193b2aeae09b80",
            "createdAt": "2024-10-11T07:35:43.468Z",
            "email": "abebe@gmail.com",
            "firstName": "abebebch",
            "lastName": "kebede",
            "role": "user",
            "updatedAt": "2024-10-15T08:49:39.357Z",
            "userName": "abebekebede1"
          }
        }
      ],
      "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

get all - success

data

object

Show child attributes

error

unknown

add get by interest