AnimeThemes/animethemes-api-docs
1
0 Fork 0
mirror of https://github.com/AnimeThemes/animethemes-api-docs.git synced 2026-10-17 16:30:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: catching up with API changes [incremental] (#16)

Browse Source
This commit is contained in:
paranarimasu authored and GitHub committed 2022-05-02 16:29:37 -05:00
1 parent 302ed5e331
commit 2b0d02de72
40 files changed
+1108 -1189
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+1 -1
View File
@@ -33,7 +33,7 @@ Please review the [**Contributing Guide**](https://github.com/AnimeThemes/animet
## Resources
For API support, please make use of the **#development** channel in the [**Discord Server**](https://discordapp.com/invite/m9zbVyQ).
For API support, please make use of the **#api** 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.
docs/README.md
+1 -1
View File
@@ -28,7 +28,7 @@ The AnimeThemes API applies the [**AnimeThemes Terms of Service**](/terms-of-ser
## Resources
For API support, please make use of the **#development** channel in the [**Discord Server**](https://discordapp.com/invite/m9zbVyQ).
For API support, please make use of the **#api** 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.
docs/anime/README.md
+3 -2
View File
@@ -27,13 +27,14 @@ For example, Bakemonogatari is an anime production with five opening sequences a
### Allowed Include Paths
* animesynonyms
* series
* animethemes
* animethemes.animethemeentries
* animethemes.animethemeentries.videos
* animethemes.song
* animethemes.song.artists
* resources
* images
* resources
* series
* studios
### Endpoints
docs/anime/index/README.md
+4 -4
View File
@@ -19,12 +19,12 @@ GET /api/anime/
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| 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 |
| q | No | The query to search for matching anime resources |
| page[size] | No | The number of anime resources to display for the current page |
| include | No | Inclusion of related resources |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| q | No | The query to search for matching anime resources |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/anime/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/anime/{slug}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/animesynonym/README.md
+1 -1
View File
@@ -8,7 +8,7 @@ title: AnimeSynonym
An AnimeSynonym API resource represents an alternate title or common abbreviation for an anime.
For example, the anime Bakemonogatari has the AnimeSynonym "Ghostory".
For example, the anime Bakemonogatari has the AnimeSynonym "Monstory".
### Fields
docs/animesynonym/index/README.md
+4 -4
View File
@@ -19,12 +19,12 @@ GET /api/animesynonym/
| Name | Required | Description |
| :----------: | :------: | :------------------------------------------------------------------------------ |
| 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 |
| q | No | The query to search for matching synonym resources |
| page[size] | No | The number of synonym resources to display for the current page |
| include | No | Inclusion of related resources |
| page[number] | No | The page of synonym resources to display |
| page[size] | No | The number of synonym resources to display for the current page |
| q | No | The query to search for matching synonym resources |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/animesynonym/show/README.md
+3 -2
View File
@@ -8,7 +8,7 @@ title: AnimeSynonym Show
The AnimeSynonym show endpoint returns an AnimeSynonym resource.
For example, the `/api/animesynonym/1523` endpoint will return the AnimeSynonym resource "Ghostory" for the anime Bakemonogatari.
For example, the `/api/animesynonym/1523` endpoint will return the AnimeSynonym resource "Monstory" for the anime Bakemonogatari.
## URL
@@ -21,8 +21,9 @@ GET /api/animesynonym/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/animetheme/index/README.md
+9 -9
View File
@@ -16,15 +16,15 @@ GET /api/animetheme/
## Parameters
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| 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 |
| 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 |
| Name | Required | Description |
| :----------: | :------: | :------------------------------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for synonym resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of synonym resources to display |
| page[size] | No | The number of synonym resources to display for the current page |
| q | No | The query to search for matching synonym resources |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/animetheme/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/animetheme/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/animethemeentry/index/README.md
+9 -9
View File
@@ -16,15 +16,15 @@ GET /api/animethemeentry/
## Parameters
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| 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 |
| 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 |
| Name | Required | Description |
| :----------: | :------: | :------------------------------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for synonym resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of synonym resources to display |
| page[size] | No | The number of synonym resources to display for the current page |
| q | No | The query to search for matching synonym resources |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/animethemeentry/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/animethemeentry/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/animeyear/show/README.md
-1
View File
@@ -22,7 +22,6 @@ GET /api/animeyear/{year}
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
## Response
docs/announcement/index/README.md
+2 -3
View File
@@ -19,11 +19,10 @@ GET /api/announcement/
| Name | Required | Description |
| :----------: | :------: | :----------------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters for announcement resources & constraining the inclusion of related resources |
| sort | No | The list of fields to sort the announcement resources |
| page[size] | No | The number of announcement resources to display for the current page |
| page[number] | No | The page of announcement resources to display |
| page[size] | No | The number of announcement resources to display for the current page |
| sort | No | The list of fields to sort the announcement resources |
## Allowed Sort Fields
docs/announcement/show/README.md
-2
View File
@@ -19,8 +19,6 @@ GET /api/announcement/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
## Response
docs/artist/README.md
+4 -4
View File
@@ -24,13 +24,13 @@ For example, Chiwa Saito is the musical performer of the Bakemonogatari OP1 them
### Allowed Include Paths
* groups
* images
* members
* resources
* songs
* songs.animethemes
* songs.animethemes.anime
* members
* groups
* resources
* images
### Endpoints
docs/artist/index/README.md
+9 -9
View File
@@ -16,15 +16,15 @@ GET /api/artist/
## Parameters
| Name | Required | Description |
| :----------: | :------: | :----------------------------------------------------------------------------- |
| 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 |
| 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 |
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| q | No | The query to search for matching anime resources |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/artist/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/artist/{slug}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/balance/index/README.md
+2 -3
View File
@@ -19,11 +19,10 @@ GET /api/balance/
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters for balance resources & constraining the inclusion of related resources |
| sort | No | The list of fields to sort the balance resources |
| page[size] | No | The number of balance resources to display for the current page |
| page[number] | No | The page of balance resources to display |
| page[size] | No | The number of balance resources to display for the current page |
| sort | No | The list of fields to sort the balance resources |
## Allowed Sort Fields
docs/balance/show/README.md
-2
View File
@@ -19,8 +19,6 @@ GET /api/balance/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
## Response
docs/image/index/README.md
+4 -4
View File
@@ -19,11 +19,11 @@ GET /api/image/
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| filter | No | Filters for image resources & constraining the inclusion of related resources |
| sort | No | The list of fields to sort the image resources |
| page[size] | No | The number of image resources to display for the current page |
| page[number] | No | The page of image resources to display |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/image/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/image/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/jsonapi/README.md
+8 -21
View File
@@ -10,25 +10,6 @@ The AnimeThemes API selectively implements the [**JSON:API Specification**](http
Here we will provide an overview of where the AnimeThemes API adheres to or deviates from the specification.
## General Strategies
The AnimeThemes API shall favor silent failures to raising exceptions.
```sh
# The anime season filter expects {winter,spring,summer,fall}
# This filter value will be discarded rather than raising an exception
/api/anime?filter[season]=autumn
```
The AnimeThemes API shall allow case-insensitive matching.
```sh
# Both query strings will match the anime year filter
/api/anime?filter[year]=2000
/api/anime?filter[Year]=2000
```
## Content Negotiation
The AnimeThemes API does **NOT** require a `Content-Type` or `Accept` header. AnimeThemes filters API requests and sets the `Accept` header on behalf of the client.
@@ -103,7 +84,10 @@ The AnimeThemes API Resource Objects relationships are included as top-level mem
...
],
images: [
...
...
],
studios: [
...
],
}
}
@@ -168,7 +152,10 @@ The AnimeThemes API does **NOT** support fetching resources or relationships.
...
],
images: [
...
...
],
studios: [
...
],
}
}
docs/page/README.md
+1 -2
View File
@@ -17,12 +17,11 @@ For example, the 'encoding/audio_normalization' page represents the documentatio
| id | Integer | No | The primary key of the resource |
| name | String | No | The primary title of the page |
| slug | String | No | The URL slug & route key of the resource |
| body | String | No | The body content of the resource |
| created_at | Date | No | The date that the resource was created |
| updated_at | Date | No | The date that the resource was last modified |
| deleted_at | Date | Yes | The date that the resource was deleted |
**Note:** At the time of writing, the `body` field of the underlying page model is purposely excluded from the page API resource due to size constraints.
### Allowed Include Paths
None
docs/page/index/README.md
+2 -2
View File
@@ -20,9 +20,9 @@ GET /api/page/
| :----------: | :------: | :--------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for page resources |
| sort | No | The list of fields to sort the resources |
| page[size] | No | The number of page resources to display for the current page |
| page[number] | No | The page of page resources to display |
| page[size] | No | The number of page resources to display for the current page |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/ratelimiting/README.md
+5 -15
View File
@@ -12,14 +12,14 @@ Here we will provide an overview of managing request quotas.
## Response Headers
The AnimeThemes API limits requests to 60 per minute.
The AnimeThemes API limits requests to 90 per minute.
The AnimeThemes API will return `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers in the response.
```sh
...
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Limit: 90
X-RateLimit-Remaining: 89
...
```
@@ -27,7 +27,7 @@ If the rate limit is exceeded, the AnimeThemes API will return `Retry-After` and
```sh
...
X-RateLimit-Limit: 60
X-RateLimit-Limit: 90
X-RateLimit-Remaining: 0
Retry-After: 60
X-RateLimit-Reset: 1625073463180
@@ -36,16 +36,6 @@ X-RateLimit-Reset: 1625073463180
```json
{
errors: [
{
status: "429",
code: "1",
title: "throttle_requests_exception",
detail: "ThrottleRequestsException",
source: {
pointer: ""
}
}
]
message: "Too Many Attempts."
}
```
docs/resource/index/README.md
+8 -8
View File
@@ -16,14 +16,14 @@ GET /api/resource/
## Parameters
| Name | Required | Description |
| :----------: | :------: | :------------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters for external resources & constraining the inclusion of related resources |
| sort | No | The list of fields to sort the external resources |
| page[size] | No | The number of external resources to display for the current page |
| page[number] | No | The page of external resources to display |
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/resource/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/resource/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/search/README.md
+3 -2
View File
@@ -19,10 +19,11 @@ GET /api/search/
| Name | Required | Description |
| :----------: | :------: | :--------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| include[type] | No | Inclusion of related resources by type |
| filter | No | Filters for wiki resources & constraining the inclusion of related resources |
| include[type] | No | Inclusion of related resources by type |
| page[limit] | No | The maximum number of wiki resource matches to return |
| q | Yes | The query to search for matching wiki resources |
| limit | No | The maximum number of wiki resource matches to return |
| sort[type] | No | The list of fields to sort the resources |
## Response
docs/series/index/README.md
+9 -9
View File
@@ -16,15 +16,15 @@ GET /api/series/
## Parameters
| Name | Required | Description |
| :----------: | :------: | :----------------------------------------------------------------------------- |
| 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 |
| 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 |
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| q | No | The query to search for matching anime resources |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/series/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/series/{slug}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/song/index/README.md
+4 -4
View File
@@ -19,12 +19,12 @@ GET /api/song/
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| filter | No | Filters for song resources & constraining the inclusion of related resources |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| q | No | The query to search for matching anime 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 |
## Allowed Sort Fields
docs/song/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/song/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/studio/index/README.md
+9 -9
View File
@@ -16,15 +16,15 @@ GET /api/studio/
## Parameters
| Name | Required | Description |
| :----------: | :------: | :----------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters for studio resources & constraining the inclusion of related resources |
| sort | No | The list of fields to sort the resources |
| q | No | The query to search for matching studio resources |
| page[size] | No | The number of studio resources to display for the current page |
| page[number] | No | The page of studio resources to display |
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| q | No | The query to search for matching anime resources |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/studio/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/studio/{slug}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
docs/transaction/index/README.md
+7 -8
View File
@@ -16,14 +16,13 @@ GET /api/transaction/
## Parameters
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters for transaction resources & constraining the inclusion of related resources |
| sort | No | The list of fields to sort the transaction resources |
| page[size] | No | The number of transaction resources to display for the current page |
| page[number] | No | The page of transaction resources to display |
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| sort | No | The list of fields to sort the resources |
## Allowed Sort Fields
docs/transaction/show/README.md
-2
View File
@@ -19,8 +19,6 @@ GET /api/transaction/{id}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
## Response
docs/video/index/README.md
+4 -4
View File
@@ -19,12 +19,12 @@ GET /api/video/
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for anime resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| filter | No | Filters for video resources & constraining the inclusion of related resources |
| page[number] | No | The page of anime resources to display |
| page[size] | No | The number of anime resources to display for the current page |
| q | No | The query to search for matching anime 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 |
## Allowed Sort Fields
docs/video/show/README.md
+2 -1
View File
@@ -21,8 +21,9 @@ GET /api/video/{basename}
| Name | Required | Description |
| :-----: | :------: | :------------------------------------------------------ |
| fields | No | Sparse fieldsets for resource types |
| include | No | Inclusion of related resources |
| filter | No | Filters to constrain the inclusion of related resources |
| include | No | Inclusion of related resources |
| sort | No | Sort related resources |
## Response
package-lock.json
Generated
+972 -1032
View File
File diff suppressed because it is too large. Load diff