diff --git a/README.md b/README.md index c438663..d488fee 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ ## Introduction -AnimeThemes is a simple and consistent repository of anime opening and ending themes. We provide direct links to high quality WebMs of your favorite OPs and EDs for your listening and discussion needs. +[**AnimeThemes**](https://animethemes.moe/) is a simple and consistent repository of anime opening and ending themes. We provide direct links to high quality WebMs of your favorite OPs and EDs for your listening and discussion needs. The AnimeThemes API provides access to our repository resources for your development needs. -This is the repository for the AnimeThemes.moe API documentation. +This is the repository for the [**AnimeThemes.moe API documentation**](https://staging.animethemes.moe/api/docs/). -This project is powered by [VuePress](https://vuepress.vuejs.org/), a minimalistic static site generator. +This project is powered by [**VuePress**](https://vuepress.vuejs.org/), a minimalistic static site generator. ## Installation diff --git a/docs/anime/index/README.md b/docs/anime/index/README.md index 4292000..1a5c145 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. | +| 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 | @@ -39,8 +39,11 @@ GET /api/anime/ ## Filters +* name +* slug * year * season +* synopsis * created_at * updated_at * deleted_at diff --git a/docs/announcement/index/README.md b/docs/announcement/index/README.md index f9e81e6..2a88094 100644 --- a/docs/announcement/index/README.md +++ b/docs/announcement/index/README.md @@ -34,6 +34,7 @@ GET /api/announcement/ ## Filters +* content * created_at * updated_at * deleted_at diff --git a/docs/artist/index/README.md b/docs/artist/index/README.md index 1a655cc..ba6d97b 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. | +| 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 | @@ -37,6 +37,8 @@ GET /api/artist/ ## Filters +* name +* slug * created_at * updated_at * deleted_at diff --git a/docs/balance/index/README.md b/docs/balance/index/README.md index a2aad33..046b810 100644 --- a/docs/balance/index/README.md +++ b/docs/balance/index/README.md @@ -42,6 +42,7 @@ GET /api/balance/ * date * service * frequency +* usage * created_at * updated_at * deleted_at diff --git a/docs/entry/index/README.md b/docs/entry/index/README.md index 2941a2f..55def24 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. | +| 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 | @@ -40,8 +40,10 @@ GET /api/entry/ ## Filters * version +* episodes * nsfw * spoiler +* notes * created_at * updated_at * deleted_at diff --git a/docs/image/index/README.md b/docs/image/index/README.md index 76ea9d6..fe0073a 100644 --- a/docs/image/index/README.md +++ b/docs/image/index/README.md @@ -38,6 +38,9 @@ GET /api/image/ ## Filters +* path +* size +* mimetype * facet * created_at * updated_at diff --git a/docs/jsonapi/README.md b/docs/jsonapi/README.md index 6b94966..1f3f9a5 100644 --- a/docs/jsonapi/README.md +++ b/docs/jsonapi/README.md @@ -408,35 +408,49 @@ NE ```sh # This will match anime not of year 2000 /api/anime?filter[year][ne]=2000 -``` +``` LT ```sh # This will match anime where the year is less than 2000 /api/anime?filter[year][lt]=2000 -``` +``` GT ```sh # This will match anime where the year is greater than 2000 /api/anime?filter[year][gt]=2000 -``` +``` LTE ```sh # This will match anime where the year is less than or equal to 2000 /api/anime?filter[year][lte]=2000 -``` +``` GTE ```sh # This will match anime where the year is greater than 2000 /api/anime?filter[year][gte]=2000 -``` +``` + +LIKE + +```sh +# This will match anime where the name matches the pattern '%monogatari%' +/api/anime?filter[name][like]=%monogatari% +``` + +NOT LIKE + +```sh +# This will match anime where the name does not match the pattern '%monogatari%' +/api/anime?filter[name][notlike]=%monogatari% +``` If a comparison operator is not provided, the filter shall use the EQ operator. diff --git a/docs/resource/index/README.md b/docs/resource/index/README.md index 841e2b2..e10dc76 100644 --- a/docs/resource/index/README.md +++ b/docs/resource/index/README.md @@ -37,6 +37,8 @@ GET /api/resource/ ## Filters +* link +* external_id * site * created_at * updated_at diff --git a/docs/series/index/README.md b/docs/series/index/README.md index fddc0b9..5f08efe 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. | +| 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 | @@ -37,6 +37,8 @@ GET /api/series/ ## Filters +* name +* slug * created_at * updated_at * deleted_at diff --git a/docs/song/index/README.md b/docs/song/index/README.md index 0d52778..4456cc3 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. | +| 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 | @@ -36,6 +36,7 @@ GET /api/song/ ## Filters +* title * created_at * updated_at * deleted_at diff --git a/docs/synonym/index/README.md b/docs/synonym/index/README.md index b8fd3ae..b50231d 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. | +| 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 | @@ -37,6 +37,7 @@ GET /api/synonym/ ## Filters +* text * created_at * updated_at * deleted_at diff --git a/docs/theme/index/README.md b/docs/theme/index/README.md index d105f33..6dd65a2 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. | +| 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 | @@ -44,6 +44,7 @@ GET /api/theme/ * type * sequence * group +* slug * created_at * updated_at * deleted_at diff --git a/docs/transaction/index/README.md b/docs/transaction/index/README.md index dea2ae7..d6803ac 100644 --- a/docs/transaction/index/README.md +++ b/docs/transaction/index/README.md @@ -41,6 +41,9 @@ GET /api/transaction/ * date * service +* description +* amount +* external_id * created_at * updated_at * deleted_at diff --git a/docs/video/index/README.md b/docs/video/index/README.md index 76fe923..37eaf0c 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. | +| 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 | @@ -47,6 +47,11 @@ GET /api/video/ ## Filters +* basename +* filename +* path +* size +* mimetype * resolution * nc * subbed