From 7df9dc11858d7a878f9aa15738ccfc34dce2b62f Mon Sep 17 00:00:00 2001 From: Pridon Tetradze Date: Fri, 6 Oct 2023 23:13:50 +0400 Subject: [PATCH] docs: grammar and spellchecking (#77) --- .gitignore | 2 +- docs/authentication.md | 11 +++++++++-- docs/cart.md | 15 ++++++++------- docs/product.md | 20 ++++++-------------- docs/qr.md | 4 ++-- docs/quote.md | 7 ++++--- docs/shop.md | 4 ++-- 7 files changed, 32 insertions(+), 31 deletions(-) diff --git a/.gitignore b/.gitignore index 4385796..692c5ac 100644 --- a/.gitignore +++ b/.gitignore @@ -39,4 +39,4 @@ lerna-debug.log* .env # Ignore copied changelog -/docs/changelog.md \ No newline at end of file +/docs/CHANGELOG.md \ No newline at end of file diff --git a/docs/authentication.md b/docs/authentication.md index 15afa75..27a701a 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -5,7 +5,7 @@ This means that, for example, if there is a user-related logic in shop or chat module that you want to integrate in your app, you will also need to use authentication endpoints. -Authentication uses access tokens through both `Authorization` header and +Authentication uses JSON Web Tokens ([JWT](https://jwt.io/)) through both `Authorization` header and cookies, allowing you to use whichever option you see fit. Base URL: @@ -14,6 +14,13 @@ Base URL: https://api.everrest.educata.dev/auth ``` +:::info NOTE +After new major release of chrome, cookies will not be supported for different-oirigin front-end apps. +This means that your front-end apps which will not be hosted on the same origin as API (edicata.dev) +will ignore cookies. It is therefore recommended to store tokens in `localStorage` or `sessionStorage` +and attatch them directly to `Authorization` request headers. +::: + ## Sign Up - Method: `POST` @@ -399,7 +406,7 @@ curl -X 'POST' \ } ``` -::: warning NOTE +::: warning WARNING This changes user's password into an automatically generated one which will be sent to their email. The user then can access his account with it and optionally [change it](#change-password). ::: diff --git a/docs/cart.md b/docs/cart.md index 57077ac..2b0488b 100644 --- a/docs/cart.md +++ b/docs/cart.md @@ -1,6 +1,6 @@ # Cart -In the cart module, users can create a cart, add products to it, proceed to checkout, delete items, and clear the cart. This operates in a simple manner, similar to how it is handled on shopping websites. +In the cart module users can create a cart, add products to it, proceed to checkout, delete items, and clear the cart. This operates in a simple manner, similar to how it is handled on shopping websites. Base URL: @@ -12,16 +12,17 @@ https://api.everrest.educata.dev/shop/cart flowchart of cart module -To use the cart module, we must follow a workflow similar to the provided flowchart. First of all, a user needs to create a cart by Create cart. Then, the user is allowed to check the cart at any time by Get cart. After that, if the user wants to add a new product to the cart, they should use the Update cart option. There may be moments when the user wants to clear the cart, for this action, we will use the Clear cart option. If the user wants to remove an item from the cart, we should use the Delete item option. Finally, if the user wants to proceed to checkout, we should use the Checkout option. +In this cart system, the cart for the user only exists when there's a need for it. A new user therefore has no cart and it should be created first. +After checkout the cart is emptied and therefore it is deleted. Adding product to the cart afterwards required creating a new cart. + +To use the cart module, we must follow a workflow similar to the provided flowchart. First of all, a user needs to create a cart by Create cart. Then, the user is allowed to check the cart at any time by Get cart. After that, if the user wants to add a new product to the cart, they should use the Update cart endpoint. There may be moments when the user wants to clear the cart, for this, the Clear cart endpoint can be used. If the user wants to remove an item from the cart, Delete item endpint should be used. Finally, if the user wants to proceed to checkout, Checkout enpoint can be used. ::: info NOTE -All endpoints for the cart module require the user to be `authorized`. This means that an access token must be attached either to cookies or the `Authorization` header. +All endpoints for the cart module require the user to be authorized. This means that an access token must be attached either to cookies or the `Authorization` header. ::: ## Create cart -To create cart, user has to choose one time for first time. - - Method: `POST` - URL: `https://api.everrest.dev/shop/cart/product` @@ -71,7 +72,7 @@ curl -X 'POST' \ ``` ::: info NOTE -This endpoint works if the user does not have a cart attached. +This endpoint works if the user does not already have a cart. ::: ## Get cart @@ -171,7 +172,7 @@ curl -X 'PATCH' \ ``` ::: info NOTE -This endpoint works if the user already have a cart attached. +This endpoint works if the user already has a cart. ::: ## Clear cart diff --git a/docs/product.md b/docs/product.md index 6c92f77..8b56c27 100644 --- a/docs/product.md +++ b/docs/product.md @@ -1,6 +1,6 @@ # Product -In the product module, users can obtain different types of products with paginated data, which means that almost all the returned data will be paginated. +In the product module users can obtain product data. Almost all endpoints support pagination. Base URL: @@ -21,8 +21,9 @@ https://api.everrest.educata.dev/shop/product "products": [...] } ``` + ::: tip Tip -Every paginated dataset can be modified using `queries` for `page` and `limit`. For example: `https://api.everrest.dev/shop/product/all?page_index=1&page_size=2` +Every paginated dataset can be modified using `queries` for `page` and `limit`. For example: `https://api.everrest.dev/shop/product/all?page_index=1&page_size=2` ::: ## All product @@ -159,7 +160,7 @@ curl -X 'GET' \ ::: info NOTE if you want to use `sort_by` or `sort_direction`, you should use -both, they are interdependance params. +both, they are interdependant params. ::: ### Example @@ -206,7 +207,7 @@ curl -X 'GET' \ "https://alta.ge/images/thumbnails/900/650/detailed/279/11_s2p2-m2.png.jpg", "https://alta.ge/images/thumbnails/900/650/detailed/279/1_34al-1v.png.jpg", "https://alta.ge/images/thumbnails/900/650/detailed/279/download_%281%29.png.jpg" - ], + ] } ] } @@ -320,15 +321,7 @@ curl -X 'GET' \ ### Response ```json -[ - "asus", - "samsung", - "xiaomi", - "apple", - "honor", - "oneplus", - "lenovo" -] +["asus", "samsung", "xiaomi", "apple", "honor", "oneplus", "lenovo"] ``` ## Brand by Name @@ -463,4 +456,3 @@ Requires access token attatched either to cookies or `Authorization` header. ] } ``` - diff --git a/docs/qr.md b/docs/qr.md index f9dae70..a6919f3 100644 --- a/docs/qr.md +++ b/docs/qr.md @@ -1,6 +1,6 @@ # QR -With this QR module, users can generate QR codes with or without an image. Response will be always in base64 format. +With the QR module, users can generate QR codes with or without an image. Response will be always in base64 format. Base URL: @@ -87,4 +87,4 @@ curl -X 'POST' \ data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAABmJLR0QA/wD/AP+gvaeTAAAWXklEQVR4nO3deZBURZ4H8G8dXdVV1V1HXxR025xyNaCuLgoMuMAqzgzuuOIYGwwza+w/8w+xRPgPYRixasTu/m04jhFu7IzrhE7MuuDGzHoM6nALKusgh3LI0UBDn3R39VF31ds/gF66Cvv142Xmy26+nwj+oV7ly3pVv86XLzN/6QJgQCHDGH06l8tl6/VSTpdnxux8dlmtTym718usPqq/fzOiy7PLrfRsRDQmBiSRRhiQRBrxlv6H6D6O2T243T6JWXmi+4B2z2dGdX2tHm/381llt76lVF8/M6X1YQtJpBEGJJFGGJBEGinrQ5aSPc5mtU9i1qcxq6/ocS+r7JYve9zU7ue1ev2tvq4b0fHBFpJIIwxIIo0wIIk0YtqHlE32uKHoPpRZ/ez2SUWPy1otX/RcX7PjS6keJ9YNW0gijTAgiTTCgCTSiON9SNX39Hb7lKrngtq9PqI/n+z1oLqtL1WNLSSRRhiQRBphQBJpxLQPqft6N9lzQ0uJHidVPVfY6vGycxKVcnoc1irR5bGFJNIIA5JIIwxIIo2U9SFVjwvKXp8oOy+o6tdLiV5PKjtvainR5cu+frLjgy0kkUYYkEQaYUASacSr+1xAp8et7L5ft3Fc0etJZa831K1PKhtbSCKNMCCJNMKAJNKIyxB8kyw7Z43d+qjOEaM72XlpRf8ezN4vey8Z2eO4bCGJNMKAJNIIA5JII2V9SNVzF+1SvR+g6j6y031g2e83M9H66HY/L1tIIo0wIIk0woAk0kjZekjR68mc7nOJZnd/StVkryc0e7/T9bFanuo8uqXlsYUk0ggDkkgjDEgijXhV9xFE7zEvu08hem6nbuOITu89Ykb1+lPV6z05l5VIYwxIIo0wIIk0IjynjupxTLuczgEjmupxNqvliR7ntDsOrNt+n2whiTTCgCTSCAOSSCMuAJZuomXnMDGjW5/I6bmzsnMU6TZObXY+2eO4sn9/bCGJNMKAJNIIA5JII5b7kKXs9illjwPK3r/QLtV9HjOy17Nafb8Zp/fnLGW3D80WkkgjDEgijTAgiTRie28P1eM4uq2Ps/p+q5zef1H3cUGz90+068cWkkgjDEgijTAgiTRiOadOKd3ylOqW88eM7PWopVTXX/dxYd2eYbCFJNIIA5JIIwxIIo2Y7u1hZrLtD6h6v0bZe13oNlfT6vF2P58Z2eOsVl9nC0mkEQYkkUYYkEQaKetDiu5zqN4bw+r5Ze/VYMZuH0v2OJxqTvcpnX7mwRaSSCMMSCKNMCCJNCJ9b49SqvO46ranvJXjg8Gg7evR2dmJb775BgcPHsSuXbsQCoWQTCZHXnd63Fm3PK6O5wCyukBZ96RHZpwOSDPhcBhPPfUUNm3ahBUrVsDn8wktP5vN4tNPP8Vbb72Fbdu2IZFIjHpd9GKDUqonDqhegG0VA1LTgFy+fDk2b96MJ554AoFAQEiZZlKpVNm5GJBjkx2QZcMepNb3vvc9bN26FevXr1d+blWBT+Nne2+PsgIV73Vhdv6J1uLqRnbeU6vnk032ekfuD0k0gTAgFXrooYecroJlDz74oNNVuKMwIBVwuVzYsmUL9uzZ43RVLNu/fz9efPFFuN38qaggPC+r6jyoTvc5SulWH1G2b9+OTZs2IZ1Oj/r/iZbXVTa7T4H5Z0+iaDTqdBWE2bBhA3bs2DGpPpOOGJCSxOPxCXmLOpZVq1Zhz549iMfjTldl0mJAShCNRrFjxw4sWbLE6aoIt2TJEraUEpWNQzqdp9LpnDWyZ4ZMFnv37sW6deuQSqXGPE709RK9l4zd8s3eb7U+bCEFcvqBgkqrVq3C22+/7XQ1Jh0GpEDPPvus01VQ6sknn3S6CpMOb1ltlnfD0qVLsW/fPuGrMyY63rJajCezcUinZ//LHpcU8YVVV1fj2LFjmD59+pjvJetE9+mdXu1jVh5vWQV44YUXGIwkBFtIm8e3tLTg8OHDqKioGPN9dHvYQpIlr732GoORhLGdl1V2XlHVLayZO2Wc8XatXbsWO3fuvO33O/39iP79WG3R2UKSUM8//7zTVZjQGJAk1Jo1a7Bs2TKnqzFhMSBJuM2bNztdhQmr7Cmr6jyYdo+3en6rbnX+cDiMjo4OJon6DslkElOnTsXAwIDyp5ROTwSwiy3kbXj66ae1C8a2wTRaEykUis4/dAoGg9iwYYPT1ZiQGJC3YePGjU5XYZTO4Qz+81Q7Xj18Acd6Bp2uDgD9rtFEwbysFgWDQSxfvtzpaoxI5grY0dqD/zh+GZ3DGRgAIn4vZkaCjtZr5cqV2t1FTARlASm6Dydz74vbKc/uONK6devg9/tt10uEQtHAZ+39+M3Xl3GqdwiFooF3T7djStCHZxY1oiHoXD39fj+WL18ufRxPdh9P9TMT3rJatHr1aqerMOJE7xDe/PoyTvcNIx7yI1jhwcWBNN765go+ONeNwWze0fqtWbPG0fNPRAxIi3QZY2sfzuCdUx3Y39aHexvCuLchDMMwYAA4cXUIvz5+GXvb+pAtFB2ro0639hMFA9KiBQsWOF0FDOUKeP9sF35/phNzYkH8YGY9gl4PUvlrwVcwDPxvRwL/fvQSvuxMjFrwahgGhrJ5JHMF6fWcP3++9HNMNl6rc01lLziVPTvf7PylSstraGiwVL5o+aKB/W29ePvEFVT7vPj5PXehaABn+5OjAi+dL2D3pauoD/oQrfRhTjSAS4NpHGpP4Jurg7ivIYLHZtaj0ivvb3I8HkckEinb8u5mTud1Ff37sfvMhE9ZJ5jjPYP4zdeXMZwr4Of33IW1zbX47287cTWVLTs2kcnjvbNd8LpdmBsL4Uj3AA61J3BhIIXVzbWYVuXH0qlys8fNnTsXhw4dknqOyYQBqZEbg/oe963/yrYNpvG7k+0425/Ej+dNxeOzpyDir8A9DWE8PmcK/nCmExcHU7j5j3zHcAbvnGyH2wX0pfMwYKDS68GfOxN471w3ZkaCqA/KSzvS1NTEgLSAfUhN9KVz+OB8N3Zf6kU6X96/S2Ry+MOZThy80o8102vx9Lw4GoI+GMa1QC6McavVm86hJ5VDwTBQH/TjkRl1mBEJ4v2zXdjb1ot8Ud6Dn3A4LK3sychr9Z7aap9S9V4doufiqtCfzuF/znbh9SOXUBfwwedxY0VjFO7rdc0VDext68N757qxoLYKP13YiOnhAAYyeRzqSOBXx9rwwbkuDIxjmGNeTQjPtDTiylAGrx2+gN+f6cTC2iosqK2S8tmqqqyVa/f7E/39q15Py1tWhw1k83j/XDe2f9uJnlQW5/qH8cbxCtRUVqCl7tqP+auuBN451Y7agA//sKhpJHgOdw3g5S/PY29bL4ay5k9NPS6gpbYKD06NIlcsojWRxEetPfjwfDcaqyoR9ov/ObCFtIa3rA4ayhXw4bluvH7kIqoqPFjZFEO2aODDc1347Ykr1yaMD6TwX6c6kCsa+PuWafiLKWG4AFxNZfFxaw/2X+7DYLYwrm2wp4QqsaiuGg1BP+6qDuDv5k/DvJoq/PF8N77o6IfNP/4kAFtIhwzn8vjofA9++dVFDGTz+OGselwZygDoRGcyi22n2xGscKNgABcGUvjx3KlY0RiD9/oDn9aBFI72DCKRGf9snPm1ISyqq8KNZ0aL66vx05ZGvPLnVrx7uhPN4QBmR4Lf+VDpdgwMDAgr605Q1kIahjHqn8vlGvXPqtLyRJNdvgypfAE7L17F60cu4mzfMB6dUY/VzbWo9nlGxgXP9CXx62NtePN4G7IFA7NjQQS8npEyYv4KNFVXIlTh+a7TjFLhdqOltgrza/6/T+d1u7CyKYYfzZmC033D+OeDZ/HaVxdx8EofhgRNHHj11Vct/Z5E//7Myhd9vNX3l34+3rIqls4XsbetD/va+jA9EsDGhdPw+Ox6TA35cf+UCB5uqkHY54UB4HwihfOJFI50D2DXxavoS+dGymkI+bGkPoypodETyKN+L2oqK0YeCN1Q4XYhHvKjJjA6Q17Y58XjsxuwuL4a75/rwr98dgb/+tk5fHS+W8lsHhqNt6wKZfJFHLzShy/a+/FAPIJ7G8Lwe9yoC1wbB6wP+jCtqhJetwselws1lRWYFQ1ibiyEaVWVI+UM5/L404Ve/OlCD4ZvChqPy4VljTHUBXzYcb4bXcnsSGDmDQMdwxn0JLOYUhLEd1VXYmk8gj+e68apvmF8fKEHw7k8fB431k6vHdUyk1wMSEWyhSK+7EzgSPcgHohHsGJabNRTzVO9w/jtiSv48Hw33C4Xfji7Hmub6zC3JoS7o0FMq/Kj0utB0TDweXsCvzx8AXsv9SJ70xhiPOTD92fWY14shMuDaey8eBUzIwFU+zzoTedxLpHCsZ7BsoAEgJqAD43Vlbg0mEYyX8DBK/34xeEL8LpdWN1cC7+HN1MqlM1ltUvHcb6b2Z072dXVZXk+a75o4PjVIZzqS+L+KRE8EI8gcNMc0nS+iB2tPfjVsUu4MpTB7GgQT8yZgp+1NKH0+Upr4tpT14NX+kYFo8flQkPQj2nXb30fiEfwWXs/lk2LYWFtCEO5AhqCfnhcLhQNo+yWNuzzYlFdNdqHMzhxdQiZQhH7LvXC63Khwu3GyqYYfBaDsqOjw/Juy1bHEUWvt1Wdqb8UW0iLTpw4YSkgC4aB033DaE2kcE99NRbVVZX9sL/tH0bHcAYxfwW6k1n4PW4EvJ6yYEzmCvjoQs/1W8rR/bvmcCVmRALwuF2oCVTggXgEc6JBzIgE8P2Z9fC4XZga8n/nD6Kxyo+/jEdwvGcQJ68OYU4shFhlBY52D+AXh1vhdQMrGmtGnvKOx8mTJ7n9uUW8D7HowIED4z62UDRwIZFCx3AGLbVVuKehuiwYs4UiuoazuKe+Gj9Z2IgHp0XxyIw6LK6vLivvSPcgPm9PIHWLhy33NkTwt3fHR1J33NcQxorGGKJ+L+bVhDArEkSs0nfLBz4AEA/5MT0SgM/jRnM4gE0Lp+Gfls/BzxY1oTuZxb8dbcPn7f1jTtErZeVa0TUMSIt27949ruOKhoGuZAb9mTzujoUwtyYEzy0CoWAAs6JB/FVzLR6f3YD1sxrw19NrsbBkKltXMoO2wRRmhAOYXxvCwrpqrJtRh1mRIIIVHiyoDeGR6bWYE70WkM3hAFY312JOLIRKrwfBivIW92bZooGzfUkM5wr4mzlT8JOFjfjBzHr8433TseX+Gaj2efHutx34siOB8Sa2s7OlwJ3KNC+rXaLzYoreDclufW59DDCQzaE3nUO1zzvyFPVWbrQ4HpcL6XwRX3T0o9LjLlsWdWkwjf50DolsHl+0J1AbqMD8mhA+b0/g8/Z+/GhOA56eN3XUey4PpQEAjTc9ob2VoVwB+9r6sON8NwJeNzbMjeP+KeGRa5EvGjjZO4RPL/fB5XJhVVMN5tWEMNaVymQyiMViSKVSJddG/7nFY5Ge55UBaa8+t5IvXluVX+Fxj3vg/oYbY42xytHjhZnrqTgGr6/2rw/6EfC60ZfO4eJACrHKCjSHR2d5u1FVs6+0K5nFV10DyOSLWFxfjabqylv2FfvTOZzuG4bn+vrKat93P4L4+OOP8eijj5b9PwOSASm1Prditq5RNzdSfwTGkT3AADCUzcPtco35x+aZZ57Bm2++Wf5+BuTY72dA2qsPlUsmk4jH4xgcLE/azICUHJCi92+0yumcPySW078/p/cC4VNWIo0wIIk0woAk0ogLGNdi8xGi81qaEZ23tZTqzzOZ7d692/JWC6of8oj+/Vg9nxm2kCREPp/Hli1bnK7GhMeAJCFefvllHD161OlqTHi8ZeUtq22tra1YvHgxhoaGLL+Xt6yjuUtzftjNOVKaI8Tsn9XyzZSWbzWnye2+vnTpUmSz5en8J7tcLoeNGzeOBKPZ9Rad08bu78Psdavnt5uDh7esghw6dAjPPfec09VQbuvWrTh48KDT1Zg0ymbqlB0geCZDKbu3hHZvSa0aqzyXy4WixLT8OnK73aOuieiZMKpvMUup7tKwhRToTuxv3omfWaayhzq6/4Wze367x5u9HwCi0Sj27NmDJUuWWCrrTmT3jkr2QzvVv2e2kBL09/dj3bp1HAYgyxiQknR0dODhhx/G3r17na6KMHv27HG6CpMeA1KiGy3l9u3bna6Kbdu2bcNjjz3mdDUmPdtPWWU/VXV64FZ1n1R3qidiOL2eUXUflS2kYq2trU5XYdwmUl0nCwakYi0tLXjppZe0ntWTz+fxyiuv8CmxEwwTuDYsMvLP7HWzf1aJPr/V+og+/sb/L1q0yNi9e/f4LoJCu3btMlpaWsZ9vc1et3q86NdF1092fUzHIUvplrNGdU4U0VauXImtW7di/fr1Ss97u5zu8+l+vN3yGJAlVAfkjfosW7YMmzdvxsaNG5We3yoGJANS6Pt1DUinzm8VA1Lu5+PuV5NcR0cHTp48iQMHDmDnzp345JNPnK4SjUF6omQzuv8FNXu/aGbXIxqNYu7cuWhubkZVVRXeeOONMctz+o5GdItiVr4Z2b83268zICdWQJodX4oBOZruAclxSCKNMCCJNFL2UMfuLZDs8syIfmope26mGbP3m51P9fdpRvQtouynvGbMrp/V68sWkkgjDEgijTAgiTTitftYXHUf0ez8Zn0sMxM9q5ns9Yp2z2+X6D6l1fLN2I0HtpBEGmFAEmmEAUmkkbLVHnbpttrC6al4ovt0os9vVp5ZfUSXb0b19bN6vN3rxxaSSCMMSCKNMCCJNGJ7LqvTfSKrVK/QFz2OZUb0OJrVubN26+P078vseKuvW8UWkkgjDEgijTAgiTRS1od0Ooub7HE8u3Mzneb092OV1e/T6T60GdnrS9lCEmmEAUmkEQYkkUa8svsQssd9nM4ZY7e+svvEsnPWmFH9fclOm2l2vN14YgtJpBEGJJFGGJBEGjFdDyk71bzV8kqpzunjdOp+s/JU57SxSnaOIrtk59E1+z7YQhJphAFJpBEGJJFGTNdDys4TapXse3yz40WXL/v6iGb3+3e6j6vb9nmcy0qkMQYkkUYYkEQaUZ6X1YzocS6r53N6bwjZ6z+d/n7MiH5GUEp1nlqr2EISaYQBSaQRBiSRRlyG5IErp/tUZlTnFTXj9NxO1etLZY8jq2a3fmwhiTTCgCTSCAOSSCNlc1lFk71+UPbczVKixwFVz520yu7nVb2XSinZc5dF94HZQhJphAFJpBEGJJFGvKrHcWTn/TQ7n+zyrPaZVOc9lZ2DSPZ6Q9l9+FKy99vkekgijTEgiTTCgCTSiGlOHbvs3qOL7pPJ7mNYfd0up/d3NKP6+7dbn1Kq8+iyhSTSCAOSSCMMSCKNlOXUcXpvA932f7RKdv3tcnqvD9V9MrvHW8X9IYkmEQYkkUYYkEQakb4e0i7RfVjRfVq745Cqx91Ez/0V/X7VfTrRzzzsXl+2kEQaYUASaYQBSaQR7fqQqnOamJUneu6rbE7P/RT9fqvPBOzWR/ZcarPzs4Uk0ggDkkgjDEgijZj2IVXn0Swlu0+mOqeK1fPbrY/qHDmi55LK3vtD9TMCjkMSTSAMSCKNMCCJNFK2HlI22Xt9mBHdR1C9V0cp1ftX2q2P6D6w6t+D7HFstpBEGmFAEmmEAUmkkf8DrliZ8L+eJRIAAAAASUVORK5CYII= ``` -sample generated image \ No newline at end of file +sample generated image diff --git a/docs/quote.md b/docs/quote.md index 093afd1..f492dbc 100644 --- a/docs/quote.md +++ b/docs/quote.md @@ -1,6 +1,6 @@ # Quote -In the quote module, users can retrieve quotes from games, series, general sources, and many other types. For fun, users can get a random quote or view all quotes through paginated data. +In the quote module, users can retrieve quotes from games, series, books, and other sources. For fun, users can get a random quote or view all quotes through paginated data. Base URL: @@ -21,8 +21,9 @@ https://api.everrest.educata.dev/quote "quotes": [...] } ``` + ::: tip Tip -Every paginated dataset can be modified using `queries` for `page` and `limit`. For example: `https://api.everrest.dev/quotes?page_index=1&page_size=2` +Every paginated dataset can be modified using `queries` for `page` and `limit`. For example: `https://api.everrest.dev/quotes?page_index=1&page_size=2` ::: ## All Quote @@ -93,4 +94,4 @@ curl -X 'GET' \ "quote": "If I’m to choose between one evil and another, I’d rather not choose at all", "type": "Game" } -``` \ No newline at end of file +``` diff --git a/docs/shop.md b/docs/shop.md index 53597b5..541d9b6 100644 --- a/docs/shop.md +++ b/docs/shop.md @@ -1,6 +1,6 @@ # Shop -EverREST provides simple CRUD operations for a shop website. This means that with EverREST as the backend, frontend developer can easily create a shop website for testing purposes. The shop endpoint is divided into two sides: +EverREST provides simple CRUD operations for a shop website. This means that with EverREST as the backend, frontend developer can easily create a shop website for learning purposes. The shop endpoint is divided into two sides: - [Product](./product.md) - [Cart](./cart.md) @@ -9,4 +9,4 @@ Base URL: ``` https://api.everrest.educata.dev/shop -``` \ No newline at end of file +```