insomnia-wyrdreader.json

{"_type":"export","__export_format":4,"__export_date":"2025-01-09T00:02:14.107Z","__export_source":"insomnia.desktop.app:v10.3.0","resources":[{"_id":"req_0e041762e5284330964757b527c6e9f4","parentId":"fld_0ec44d32885f4fe98e944e02c0698fbc","modified":1736377686894,"created":1736377632074,"url":"http://localhost:8080/books","name":"list of books","description":"Get a paginated list of books<br>\nParameters 'offset' (default: 0) and 'limit' (default: 10) must be included in query (optional)<br>\nexample: '/books?offset=10', '/books?limit=50', 'books?offset=0&limit=10'\n\n\n","method":"GET","body":{},"parameters":[{"id":"pair_c015a5ef2cbd438cac68100403cdb6c3","name":"offset","value":"0","description":"","disabled":false},{"id":"pair_f5254bd5b82c441db8aa218ade3bc471","name":"limit","value":"10","description":"","disabled":false}],"headers":[{"id":"pair_62dc97a20dad47859d5b85b70a34905c","name":"Content-Type","value":"application/json","description":"","disabled":false}],"authentication":{},"metaSortKey":-1736352704635,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_0ec44d32885f4fe98e944e02c0698fbc","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736377632074,"created":1736377632074,"name":"Books","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1736352820394,"environmentType":"kv","_type":"request_group"},{"_id":"wrk_cb2bf255ccab45d4b8554f2398d797d5","parentId":null,"modified":1736377632052,"created":1736377632052,"name":"Wyrdreader REST-API docs","description":"","scope":"collection","_type":"workspace"},{"_id":"req_f474345091c343829424cf84409ca5f8","parentId":"fld_0ec44d32885f4fe98e944e02c0698fbc","modified":1736377926035,"created":1736377632075,"url":"http://localhost:8080/books/{id}","name":"book details by id","description":"Get details of a book by ID <br>\nDetails of book including id, title, authors, cover-image, release-date, number of pages, book-description, genres, reviews, ratings<br>\nexample: '/books/1'\n\n","method":"GET","body":{},"parameters":[],"headers":[{"id":"pair_54feca2e9ed24bb7b6b763aa782e82f9","name":"Content-type","value":"application/json","description":"","disabled":false}],"authentication":{},"metaSortKey":-1736352704535,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_3e97db7ed390472f88cface9b0a80a44","parentId":"fld_4dee3b218be741bb8ec5aa11892322d9","modified":1736377981173,"created":1736377632078,"url":"http://localhost:8080/authors","name":"list of authors","description":"Get a list of authors\n","method":"GET","body":{},"parameters":[],"headers":[{"name":"Content-type","value":"application/json","id":"pair_08e32e1cf4a54d3f8972578a12be92fe"}],"authentication":{},"metaSortKey":-1736352784420,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_4dee3b218be741bb8ec5aa11892322d9","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736377632076,"created":1736377632076,"name":"Authors","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1736352820369,"environmentType":"kv","_type":"request_group"},{"_id":"req_0ef31bc067714deca90688d10345faf3","parentId":"fld_4dee3b218be741bb8ec5aa11892322d9","modified":1736378050599,"created":1736377632078,"url":"http://localhost:8080/authors/{id}","name":"author by id","description":"Get details of a specific author by ID including books by author <br>\nexample: '/authors/1'\n","method":"GET","body":{},"parameters":[],"headers":[{"name":"Content-type","value":"application/json","id":"pair_c39a3044c89b44d69cdce73f3205eda2"}],"authentication":{},"metaSortKey":-1736352784320,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_91f78654e49c4f88a7ce374c5d6677d3","parentId":"fld_077a4a17c8a24f9f895660906f5482d6","modified":1736378285755,"created":1736377632080,"url":"http://localhost:8080/genres","name":"list of genres","description":"Get list of genres<br>\n","method":"GET","body":{},"parameters":[],"headers":[{"name":"Content-type","value":"application/json","id":"pair_e9b4ffbda5b14b26a2fb8448a119f2a5"}],"authentication":{},"metaSortKey":-1736352830152,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_077a4a17c8a24f9f895660906f5482d6","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736377632079,"created":1736377632079,"name":"Genres","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1736352820344,"environmentType":"kv","_type":"request_group"},{"_id":"req_e1e100dbe6f94793a2ac506dcd4e761c","parentId":"fld_077a4a17c8a24f9f895660906f5482d6","modified":1736378302708,"created":1736377632081,"url":"http://localhost:8080/genres/{id}","name":"genre by id","description":"Get description of specific genre by ID, including books of the genre<br>\nexample: '/genres/1'\n","method":"GET","body":{},"parameters":[],"headers":[{"name":"Content-type","value":"application/json","id":"pair_c35c883c633d407fa9907bb98ee73ca8"}],"authentication":{},"metaSortKey":-1736352830052,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_32c0c73e7c2342c6a1f45047614cab40","parentId":"fld_0b5ac7067482497bbf61df3f15b5f60a","modified":1736378265578,"created":1736377632058,"url":"http://localhost:8080/register/","name":"register new user","description":"Register a new user.<br>\nRegisters a new user by providing username, email, and password. The password will be hashed and salted before storing in the database.\n\n","method":"POST","body":{"mimeType":"multipart/form-data","params":[{"id":"pair_fc064769637844fbbaa2669cc0b4df06","name":"email","value":"email@mail.com","description":"","disabled":false},{"id":"pair_fc38d34047234699b5ab88c442a89ea4","name":"username","value":"username","description":"","disabled":false},{"id":"pair_6788c0eb2f6c42a5ae0bdcd37d9045d7","name":"password","value":"password","description":"","disabled":false}]},"parameters":[],"headers":[{"name":"Content-Type","value":"multipart/form-data","id":"pair_b2f5a55c7c6b4e97983d29abc02557a8"}],"authentication":{},"metaSortKey":-1736350842248,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_0b5ac7067482497bbf61df3f15b5f60a","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736378164174,"created":1736377632057,"name":"Auth","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1736352722368,"environmentType":"kv","_type":"request_group"},{"_id":"req_ca6ae326da37459d973aa7e68eea8a4a","parentId":"fld_0b5ac7067482497bbf61df3f15b5f60a","modified":1736378427838,"created":1736377632057,"url":"http://localhost:8080/login","name":"login user","description":"User login and token generation.<br>\nAuthenticates a user with email and password, and returns a JWT token if the credentials are valid.<br>\nThe token is required for user actions like rating and reviewing books, and managing user's booklist\n\n\t","method":"POST","body":{"mimeType":"multipart/form-data","params":[{"id":"pair_2dfb4ca70ed44421957c0c499a803698","name":"email","value":"email@mail.com","description":"","disabled":false},{"id":"pair_3ee3fecc6cb04d3396fb7113575324b9","name":"password","value":"password","description":"","disabled":false}]},"parameters":[],"headers":[{"name":"Content-Type","value":"multipart/form-data","id":"pair_504755c730ec4bb78061516ff3b7010f"}],"authentication":{},"metaSortKey":-1736350842148,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_0b90ba94953a459f8b302dd7b360cc5f","parentId":"fld_4da92fea9a594572b20b35fff7951fda","modified":1736379026351,"created":1736377632072,"url":"http://localhost:8080/rate/","name":"create book rating","description":"Rate a book from 1 to 5, or update previous rating, by authenticated user<br>\nPost request checks if rating of book by authenticated user already exist, and updates the rating if so, and else submits new rating<br>\nPatch request to update the rating is allowed, but not necessary to use<br><br>\nrequest=POST<br>\nresponse=200, \"Rating updated succesfully\"<br>\nresponse=201, \"Rating submitted succesfully\"<br><br>\n\nnote: endpoint must include trailing slash, '/rate/'\n","method":"POST","body":{"mimeType":"application/json","text":"{\n\t\"bookId\": 5,\n\t\"rating\": 3\n}"},"parameters":[{"id":"pair_2e94acd26fb54e1b96be99c3c8f190ea","name":"","value":"","description":"","disabled":false}],"headers":[{"name":"Content-Type","value":"application/json","id":"pair_f9e44672750947cd95d76c0b7d652275"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352646421,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_4da92fea9a594572b20b35fff7951fda","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736377632071,"created":1736377632071,"name":"Rating","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1736352624392,"environmentType":"kv","_type":"request_group"},{"_id":"req_947a47a6c4b2407285432905d34a0b05","parentId":"fld_f4e02de24e064f4497c3cf007152631b","modified":1736379153421,"created":1736377632068,"url":"http://localhost:8080/review/","name":"create book review","description":"Submit a new review.<br>\nAllows authenticated users to submit a new review for a specific book.<br><br>\nnote: must include trailing slash, '/review/'\n","method":"POST","body":{"mimeType":"application/json","text":"{\n\t\"bookId\": 11,\n\t\"review\": \"Really great book\"\n}"},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json","id":"pair_535df9f918824a139ebd77b94c7d32c0"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352467777,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_f4e02de24e064f4497c3cf007152631b","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736377632067,"created":1736377632067,"name":"Review","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1736352445164,"environmentType":"kv","_type":"request_group"},{"_id":"req_9226651d46a54e468c2a64a0a2cca84f","parentId":"fld_f4e02de24e064f4497c3cf007152631b","modified":1736379262207,"created":1736377632069,"url":"http://localhost:8080/review/","name":"update book review ","description":"Update an existing review.<br>\nAllows authenticated users to update a previous review for a specific book.<br><br>\nnote: must include trailing slash, '/review/'\n\t\n","method":"PATCH","body":{"mimeType":"application/json","text":"{\n\t\"reviewId\": 14,\n\t\"review\": \"Really, really great book\"\n}"},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json","id":"pair_a081aa0893b747489902c5fa23be951b"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352467677,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_eafc2ed242ff4d34b1abbba7e4779790","parentId":"fld_f4e02de24e064f4497c3cf007152631b","modified":1736379336867,"created":1736377632070,"url":"http://localhost:8080/review/","name":"delete book review","description":"Delete an existing review.<br>\nAllows authenticated users to delete review for a specific book.<br><br>\nnote: must include trailing slash, '/review/'\n\t\n","method":"DELETE","body":{"mimeType":"application/json","text":"{\n\t\"reviewId\": 14\n}"},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json","id":"pair_1c1eeac1acab41688b45a6e52a389c59"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352467627,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_50225db4b0f54e0aa606f00a2a5ccaf2","parentId":"fld_767a1acc1c4248c687820d64cf709907","modified":1736379421463,"created":1736377632064,"url":"http://localhost:8080/users/me","name":"get current user info","description":" Get current user details<br>\n Retrieves the details (id, email, username) of authenticated user\n\t\n \n","method":"GET","body":{},"parameters":[],"headers":[{"name":"Content-type","value":"application/json","id":"pair_2ed10b8b25954abc82bf917e307ff7d2"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352387815,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_767a1acc1c4248c687820d64cf709907","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736378148259,"created":1736377632059,"name":"Users","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1736352365371,"environmentType":"kv","_type":"request_group"},{"_id":"req_18cd6da6a42444bd9343abf168373c44","parentId":"fld_767a1acc1c4248c687820d64cf709907","modified":1736380028901,"created":1736377632065,"url":"http://localhost:8080/users/me/","name":"update current user email and username","description":" Update current user details<br>\n Allows the authenticated user to update their email and/or username.<br><br>\nnote: must include trailing slash, /users/me/\n ","method":"PATCH","body":{"mimeType":"application/json","text":"{\n\t\"username\": \"new username\",\n\t\"email\": \"newemail@mail.com\"\n}"},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352387765,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_c2a31d1ed46d499aa86466f34fcc5374","parentId":"fld_767a1acc1c4248c687820d64cf709907","modified":1736380124870,"created":1736377632065,"url":"http://localhost:8080/users/me/","name":"update current user password","description":" Update current user password<br>\n Allows the authenticated user to update their password.<br><br>\n note: must include trailing slash, '/users/me/'\n\t\n","method":"PATCH","body":{"mimeType":"application/json","text":"{\n\t\"current_password\": \"password\",\n\t\"new_password\": \"newpassword\"\n}"},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json","id":"pair_45100de3071c45c7986778ba9757cb99"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352387715,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_28edeb45c2b44cd8b636a003da996488","parentId":"fld_767a1acc1c4248c687820d64cf709907","modified":1736380199136,"created":1736377632066,"url":"http://localhost:8080/users/me/","name":"delete current user","description":"Delete current user<br>\nAllows the authenticated user to delete their account.<br><br>\nnote: must include trailing slash, /users/me/\n\n\n","method":"DELETE","body":{"mimeType":"application/json","text":"{\n\t\"userId\": 7\n}"},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json","id":"pair_e08a303adccd427b8ba4bbd1c7ece649"},{"name":"User-Agent","value":"insomnia/10.3.0","id":"pair_43cdf48cbace46caab88836c0db1d3bb"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352387640,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_fc817ba294b74a65b401ee51accbdedf","parentId":"fld_767a1acc1c4248c687820d64cf709907","modified":1736380916567,"created":1736377632060,"url":"http://localhost:8080/mybooks","name":"get current user's booklist","description":"Get the list of books for the authenticated user<br>\nFetches the list of books saved by the user<br>","method":"GET","body":{"mimeType":"application/json","text":""},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352387627.5,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_4bdebb93a484408593225e4a0bad6e05","parentId":"fld_767a1acc1c4248c687820d64cf709907","modified":1736380318175,"created":1736377632061,"url":"http://localhost:8080/mybooks/","name":"add book to user's booklist","description":"Add a book to the user's list<br>\nAdds a book to the authenticated user's reading list.<br><br>\nnote: must include trailing slash, /mybooks/\n\n","method":"POST","body":{"mimeType":"application/json","text":"{\n\t\"bookId\": 1\n}"},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json","id":"pair_bbb086df09c948559ab75fd8b29c1e88"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352387624.375,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_4c73e8f0d2214e41b553b2a38d56b7f3","parentId":"fld_767a1acc1c4248c687820d64cf709907","modified":1736380367458,"created":1736377632063,"url":"http://localhost:8080/mybooks/","name":"delete book from user's booklist","description":"Delete a book from the user's list<br>\nDeletes a book from the authenticated user's reading list.<br><br>\nnote: must include trailing slash, /mybooks/\n","method":"DELETE","body":{"mimeType":"application/json","text":"{\n\t\"bookId\": 1\n}"},"parameters":[],"headers":[{"name":"Content-Type","value":"application/json","id":"pair_e2499702e4d84bff9266c4b0fdb0f34b"}],"authentication":{"type":"bearer","token":"<token>"},"metaSortKey":-1736352387621.25,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"env_ebf26fade0c44e7aa6ca7b6af4c6f06c","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736377632053,"created":1736377632053,"name":"Base Environment","data":{},"dataPropertyOrder":null,"color":null,"isPrivate":false,"metaSortKey":1736335248274,"environmentType":"kv","_type":"environment"},{"_id":"jar_d2c3ffb28bfd48b6bd7a5136a5ee0520","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736377632055,"created":1736377632055,"name":"Default Jar","cookies":[],"_type":"cookie_jar"},{"_id":"spc_644e626af7f6495f993ab793ae2ebb7c","parentId":"wrk_cb2bf255ccab45d4b8554f2398d797d5","modified":1736377632087,"created":1736377632086,"fileName":"Wyrdreader REST-API docs","contents":"","contentType":"yaml","_type":"api_spec"}]}