From bca7476a5d08288a4d34240aab6ad753c9161dc9 Mon Sep 17 00:00:00 2001 From: paranarimasu <33796518+paranarimasu@users.noreply.github.com> Date: Wed, 7 Jul 2021 23:40:53 -0500 Subject: [PATCH] fix: sorting is now supported for searching --- README.md | 14 +++++- docs/anime/index/README.md | 2 +- docs/artist/index/README.md | 2 +- docs/entry/index/README.md | 2 +- docs/series/index/README.md | 2 +- docs/song/index/README.md | 2 +- docs/synonym/index/README.md | 2 +- docs/theme/index/README.md | 2 +- docs/video/index/README.md | 2 +- package-lock.json | 84 ++++++++++++++++++------------------ 10 files changed, 63 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 6061766..c438663 100644 --- a/README.md +++ b/README.md @@ -25,4 +25,16 @@ In the project root directory, start the local development server. `npm run dev` -That's it! The local development server should be running at `localhost:8080`. \ No newline at end of file +That's it! The local development server should be running at `localhost:8080`. + +## Contributing + +Please review the [**Contributing Guide**](https://github.com/AnimeThemes/animethemes-api-docs/blob/main/.github/CONTRIBUTING.md) for detailed instructions. + +## Resources + +For API support, please make use of the **#development** channel in the [**Discord Server**](https://discordapp.com/invite/m9zbVyQ). + +To report an issue with or request a new feature for the API, please make use of the [**animethemes-server**](https://github.com/AnimeThemes/animethemes-server) Github. + +To report an issue with or request a new feature for this documentation, please make use of this repository. \ No newline at end of file diff --git a/docs/anime/index/README.md b/docs/anime/index/README.md index a944aef..4292000 100644 --- a/docs/anime/index/README.md +++ b/docs/anime/index/README.md @@ -21,7 +21,7 @@ GET /api/anime/ | fields | No | Sparse fieldsets for resource types | | include | No | Inclusion of related resources | | filter | No | Filters for anime resources & constraining the inclusion of related resources | -| sort | No | The list of fields to sort the resources. Ignored if search query is present. | +| sort | No | The list of fields to sort the resources. | | q | No | The query to search for matching anime resources | | page[size] | No | The number of anime resources to display for the current page | | page[number] | No | The page of anime resources to display | diff --git a/docs/artist/index/README.md b/docs/artist/index/README.md index 9967a3a..1a655cc 100644 --- a/docs/artist/index/README.md +++ b/docs/artist/index/README.md @@ -21,7 +21,7 @@ GET /api/artist/ | fields | No | Sparse fieldsets for resource types | | include | No | Inclusion of related resources | | filter | No | Filters for artist resources & constraining the inclusion of related resources | -| sort | No | The list of fields to sort the resources. Ignored if search query is present. | +| sort | No | The list of fields to sort the resources. | | q | No | The query to search for matching artist resources | | page[size] | No | The number of artist resources to display for the current page | | page[number] | No | The page of artist resources to display | diff --git a/docs/entry/index/README.md b/docs/entry/index/README.md index 4168f7e..2941a2f 100644 --- a/docs/entry/index/README.md +++ b/docs/entry/index/README.md @@ -21,7 +21,7 @@ GET /api/entry/ | fields | No | Sparse fieldsets for resource types | | include | No | Inclusion of related resources | | filter | No | Filters for entry resources & constraining the inclusion of related resources | -| sort | No | The list of fields to sort the resources. Ignored if search query is present. | +| sort | No | The list of fields to sort the resources. | | q | No | The query to search for matching entry resources | | page[size] | No | The number of entry resources to display for the current page | | page[number] | No | The page of entry resources to display | diff --git a/docs/series/index/README.md b/docs/series/index/README.md index 1d84640..fddc0b9 100644 --- a/docs/series/index/README.md +++ b/docs/series/index/README.md @@ -21,7 +21,7 @@ GET /api/series/ | fields | No | Sparse fieldsets for resource types | | include | No | Inclusion of related resources | | filter | No | Filters for series resources & constraining the inclusion of related resources | -| sort | No | The list of fields to sort the resources. Ignored if search query is present. | +| sort | No | The list of fields to sort the resources. | | q | No | The query to search for matching series resources | | page[size] | No | The number of series resources to display for the current page | | page[number] | No | The page of series resources to display | diff --git a/docs/song/index/README.md b/docs/song/index/README.md index 08c5009..0d52778 100644 --- a/docs/song/index/README.md +++ b/docs/song/index/README.md @@ -21,7 +21,7 @@ GET /api/song/ | fields | No | Sparse fieldsets for resource types | | include | No | Inclusion of related resources | | filter | No | Filters for song resources & constraining the inclusion of related resources | -| sort | No | The list of fields to sort the resources. Ignored if search query is present. | +| sort | No | The list of fields to sort the resources. | | q | No | The query to search for matching song resources | | page[size] | No | The number of song resources to display for the current page | | page[number] | No | The page of song resources to display | diff --git a/docs/synonym/index/README.md b/docs/synonym/index/README.md index 977404e..b8fd3ae 100644 --- a/docs/synonym/index/README.md +++ b/docs/synonym/index/README.md @@ -21,7 +21,7 @@ GET /api/synonym/ | fields | No | Sparse fieldsets for resource types | | include | No | Inclusion of related resources | | filter | No | Filters for synonym resources & constraining the inclusion of related resources | -| sort | No | The list of fields to sort the resources. Ignored if search query is present. | +| sort | No | The list of fields to sort the resources. | | q | No | The query to search for matching synonym resources | | page[size] | No | The number of synonym resources to display for the current page | | page[number] | No | The page of synonym resources to display | diff --git a/docs/theme/index/README.md b/docs/theme/index/README.md index c17d843..d105f33 100644 --- a/docs/theme/index/README.md +++ b/docs/theme/index/README.md @@ -21,7 +21,7 @@ GET /api/theme/ | fields | No | Sparse fieldsets for resource types | | include | No | Inclusion of related resources | | filter | No | Filters for theme resources & constraining the inclusion of related resources | -| sort | No | The list of fields to sort the resources. Ignored if search query is present. | +| sort | No | The list of fields to sort the resources. | | q | No | The query to search for matching theme resources | | page[size] | No | The number of theme resources to display for the current page | | page[number] | No | The page of theme resources to display | diff --git a/docs/video/index/README.md b/docs/video/index/README.md index 86b55bc..76fe923 100644 --- a/docs/video/index/README.md +++ b/docs/video/index/README.md @@ -21,7 +21,7 @@ GET /api/video/ | fields | No | Sparse fieldsets for resource types | | include | No | Inclusion of related resources | | filter | No | Filters for video resources & constraining the inclusion of related resources | -| sort | No | The list of fields to sort the resources. Ignored if search query is present. | +| sort | No | The list of fields to sort the resources. | | q | No | The query to search for matching video resources | | page[size] | No | The number of video resources to display for the current page | | page[number] | No | The page of video resources to display | diff --git a/package-lock.json b/package-lock.json index 2e7a6d3..3d4d8c1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1649,9 +1649,9 @@ } }, "node_modules/@types/glob": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/@types/glob/-/glob-7.1.3.tgz", - "integrity": "sha512-SEYeGAIQIQX8NN6LDKprLjbrd5dARM5EXsd8GI/A5l0apYI1fGMWgPHSe4ZKL4eozlAyI+doUE9XbYS4xCkQ1w==", + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/@types/glob/-/glob-7.1.4.tgz", + "integrity": "sha512-w+LsMxKyYQm347Otw+IfBXOv9UWVjpHpCDdbBMt8Kz/xbvCYNjP+0qPh91Km3iKfSRLBB0P7fAMf0KHrPu+MyA==", "dev": true, "dependencies": { "@types/minimatch": "*", @@ -1659,27 +1659,27 @@ } }, "node_modules/@types/json-schema": { - "version": "7.0.7", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", - "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", + "version": "7.0.8", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.8.tgz", + "integrity": "sha512-YSBPTLTVm2e2OoQIDYx8HaeWJ5tTToLH67kXR7zYNGupXMEHa2++G8k+DczX2cFVgalypqtyZIcU19AFcmOpmg==", "dev": true }, "node_modules/@types/minimatch": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.4.tgz", - "integrity": "sha512-1z8k4wzFnNjVK/tlxvrWuK5WMt6mydWWP7+zvH5eFep4oj+UkrfiJTRtjCeBXNpwaA/FYqqtb4/QS4ianFpIRA==", + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.5.tgz", + "integrity": "sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ==", "dev": true }, "node_modules/@types/node": { - "version": "16.0.0", - "resolved": "https://registry.npmjs.org/@types/node/-/node-16.0.0.tgz", - "integrity": "sha512-TmCW5HoZ2o2/z2EYi109jLqIaPIi9y/lc2LmDCWzuCi35bcaQ+OtUh6nwBiFK7SOu25FAU5+YKdqFZUwtqGSdg==", + "version": "16.0.1", + "resolved": "https://registry.npmjs.org/@types/node/-/node-16.0.1.tgz", + "integrity": "sha512-hBOx4SUlEPKwRi6PrXuTGw1z6lz0fjsibcWCM378YxsSu/6+C30L6CR49zIBKHiwNWCYIcOLjg4OHKZaFeLAug==", "dev": true }, "node_modules/@types/q": { - "version": "1.5.4", - "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.4.tgz", - "integrity": "sha512-1HcDas8SEj4z1Wc696tH56G8OlRaH/sqZOynNNB+HF0WOeXPaxTtbYzJY2oEfiUxjSKjhCKr+MvR7dCHcEelug==", + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.5.tgz", + "integrity": "sha512-L28j2FcJfSZOnL1WBjDYp2vUHCeIFlyYI/53EwD/rKUBQ7MtUUfbQWiyKJGpcnv4/WgrhWsFKrcPstcAt/J0tQ==", "dev": true }, "node_modules/@vue/babel-helper-vue-jsx-merge-props": { @@ -3691,9 +3691,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001242", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001242.tgz", - "integrity": "sha512-KvNuZ/duufelMB3w2xtf9gEWCSxJwUgoxOx5b6ScLXC4kPc9xsczUVCPrQU26j5kOsHM4pSUL54tAZt5THQKug==", + "version": "1.0.30001243", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001243.tgz", + "integrity": "sha512-vNxw9mkTBtkmLFnJRv/2rhs1yufpDfCkBZexG3Y0xdOH2Z/eE/85E4Dl5j1YUN34nZVsSp6vVRFQRrez9wJMRA==", "dev": true, "funding": { "type": "opencollective", @@ -5360,9 +5360,9 @@ "dev": true }, "node_modules/electron-to-chromium": { - "version": "1.3.766", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.766.tgz", - "integrity": "sha512-u2quJ862q9reRKh/je3GXis3w38+RoXH1J9N3XjtsS6NzmUAosNsyZgUVFZPN/ZlJ3v6T0rTyZR3q/J5c6Sy5w==", + "version": "1.3.770", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.770.tgz", + "integrity": "sha512-Kyh8DGK1KfEZuYKIHvuOmrKotsKZQ+qBkDIWHciE3QoFkxXB1KzPP+tfLilSHAfxTON0yYMnFCWkQtUOR7g6KQ==", "dev": true }, "node_modules/elliptic": { @@ -15225,9 +15225,9 @@ } }, "@types/glob": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/@types/glob/-/glob-7.1.3.tgz", - "integrity": "sha512-SEYeGAIQIQX8NN6LDKprLjbrd5dARM5EXsd8GI/A5l0apYI1fGMWgPHSe4ZKL4eozlAyI+doUE9XbYS4xCkQ1w==", + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/@types/glob/-/glob-7.1.4.tgz", + "integrity": "sha512-w+LsMxKyYQm347Otw+IfBXOv9UWVjpHpCDdbBMt8Kz/xbvCYNjP+0qPh91Km3iKfSRLBB0P7fAMf0KHrPu+MyA==", "dev": true, "requires": { "@types/minimatch": "*", @@ -15235,27 +15235,27 @@ } }, "@types/json-schema": { - "version": "7.0.7", - "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", - "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", + "version": "7.0.8", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.8.tgz", + "integrity": "sha512-YSBPTLTVm2e2OoQIDYx8HaeWJ5tTToLH67kXR7zYNGupXMEHa2++G8k+DczX2cFVgalypqtyZIcU19AFcmOpmg==", "dev": true }, "@types/minimatch": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.4.tgz", - "integrity": "sha512-1z8k4wzFnNjVK/tlxvrWuK5WMt6mydWWP7+zvH5eFep4oj+UkrfiJTRtjCeBXNpwaA/FYqqtb4/QS4ianFpIRA==", + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.5.tgz", + "integrity": "sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ==", "dev": true }, "@types/node": { - "version": "16.0.0", - "resolved": "https://registry.npmjs.org/@types/node/-/node-16.0.0.tgz", - "integrity": "sha512-TmCW5HoZ2o2/z2EYi109jLqIaPIi9y/lc2LmDCWzuCi35bcaQ+OtUh6nwBiFK7SOu25FAU5+YKdqFZUwtqGSdg==", + "version": "16.0.1", + "resolved": "https://registry.npmjs.org/@types/node/-/node-16.0.1.tgz", + "integrity": "sha512-hBOx4SUlEPKwRi6PrXuTGw1z6lz0fjsibcWCM378YxsSu/6+C30L6CR49zIBKHiwNWCYIcOLjg4OHKZaFeLAug==", "dev": true }, "@types/q": { - "version": "1.5.4", - "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.4.tgz", - "integrity": "sha512-1HcDas8SEj4z1Wc696tH56G8OlRaH/sqZOynNNB+HF0WOeXPaxTtbYzJY2oEfiUxjSKjhCKr+MvR7dCHcEelug==", + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.5.tgz", + "integrity": "sha512-L28j2FcJfSZOnL1WBjDYp2vUHCeIFlyYI/53EwD/rKUBQ7MtUUfbQWiyKJGpcnv4/WgrhWsFKrcPstcAt/J0tQ==", "dev": true }, "@vue/babel-helper-vue-jsx-merge-props": { @@ -16951,9 +16951,9 @@ } }, "caniuse-lite": { - "version": "1.0.30001242", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001242.tgz", - "integrity": "sha512-KvNuZ/duufelMB3w2xtf9gEWCSxJwUgoxOx5b6ScLXC4kPc9xsczUVCPrQU26j5kOsHM4pSUL54tAZt5THQKug==", + "version": "1.0.30001243", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001243.tgz", + "integrity": "sha512-vNxw9mkTBtkmLFnJRv/2rhs1yufpDfCkBZexG3Y0xdOH2Z/eE/85E4Dl5j1YUN34nZVsSp6vVRFQRrez9wJMRA==", "dev": true }, "caseless": { @@ -18334,9 +18334,9 @@ "dev": true }, "electron-to-chromium": { - "version": "1.3.766", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.766.tgz", - "integrity": "sha512-u2quJ862q9reRKh/je3GXis3w38+RoXH1J9N3XjtsS6NzmUAosNsyZgUVFZPN/ZlJ3v6T0rTyZR3q/J5c6Sy5w==", + "version": "1.3.770", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.770.tgz", + "integrity": "sha512-Kyh8DGK1KfEZuYKIHvuOmrKotsKZQ+qBkDIWHciE3QoFkxXB1KzPP+tfLilSHAfxTON0yYMnFCWkQtUOR7g6KQ==", "dev": true }, "elliptic": {