mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-07-11 01:34:06 +02:00
feat: add anime image endpoints (#39)
This commit is contained in:
@@ -66,6 +66,28 @@ module.exports = {
|
||||
},
|
||||
]
|
||||
},
|
||||
'animeimage': {
|
||||
title: 'Resource',
|
||||
to: '/animeimage',
|
||||
children: [
|
||||
{
|
||||
title: 'Destroy',
|
||||
to: '/animeimage/destroy/'
|
||||
},
|
||||
{
|
||||
title: 'Index',
|
||||
to: '/animeimage/index/'
|
||||
},
|
||||
{
|
||||
title: 'Show',
|
||||
to: '/animeimage/show/',
|
||||
},
|
||||
{
|
||||
title: 'Store',
|
||||
to: '/animeimage/store/',
|
||||
}
|
||||
]
|
||||
},
|
||||
'animesynonym': {
|
||||
title: 'Resource',
|
||||
to: '/animesynonym',
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Destroy
|
||||
|
||||
The anime destroy endpoint soft deletes an anime and returns the deleted anime resource.
|
||||
|
||||
For example, the `/api/anime/bakemonogatari` endpoint will soft delete the Bakemonogatari anime and return the deleted Bakemonogatari resource.
|
||||
For example, the `/anime/bakemonogatari` endpoint will soft delete the Bakemonogatari anime and return the deleted Bakemonogatari resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/anime/{slug}
|
||||
DELETE /anime/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Force Delete
|
||||
|
||||
The anime force delete endpoint hard deletes an anime and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/anime/bakemonogatari` endpoint will hard delete the Bakemonogatari anime and return a confirmation message.
|
||||
For example, the `/forceDelete/anime/bakemonogatari` endpoint will hard delete the Bakemonogatari anime and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/anime/{slug}
|
||||
DELETE /forceDelete/anime/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The anime index endpoint returns a listing of anime resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/anime/
|
||||
GET /anime/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Show
|
||||
|
||||
The anime show endpoint returns an anime resource.
|
||||
|
||||
For example, the `/api/anime/bakemonogatari` endpoint will return the Bakemonogatari resource for the Bakemonogatari anime.
|
||||
For example, the `/anime/bakemonogatari` endpoint will return the Bakemonogatari resource for the Bakemonogatari anime.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/anime/{slug}
|
||||
GET /anime/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Store
|
||||
|
||||
The anime store endpoint creates a new anime and returns the new anime resource.
|
||||
|
||||
For example, the `/api/anime?name=Bakemonogatari&slug=bakemonogatari&year=2009&season=summer` endpoint will create a new Bakemonogatari anime and return the new Bakemonogatari resource.
|
||||
For example, the `/anime?name=Bakemonogatari&slug=bakemonogatari&year=2009&season=summer` endpoint will create a new Bakemonogatari anime and return the new Bakemonogatari resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/anime
|
||||
POST /anime
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Update
|
||||
|
||||
The anime update endpoint updates an anime and returns the updated anime resource.
|
||||
|
||||
For example, the `/api/anime/bakemonogatari?synopsis=updated+text` endpoint will update the Bakemonogatari anime synopsis attribute and return the updated Bakemonogatari resource.
|
||||
For example, the `/anime/bakemonogatari?synopsis=updated+text` endpoint will update the Bakemonogatari anime synopsis attribute and return the updated Bakemonogatari resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/anime/{slug}
|
||||
PUT|PATCH /anime/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Anime Image
|
||||
---
|
||||
|
||||
# Anime Image
|
||||
|
||||
---
|
||||
|
||||
An anime image API resource represents the association between an anime and an image.
|
||||
|
||||
### Fields
|
||||
|
||||
| Name | Type | Nullable | Description |
|
||||
| :--------: | :-----: | :------: | :------------------------------------------- |
|
||||
| created_at | Date | No | The date that the resource was created |
|
||||
| updated_at | Date | No | The date that the resource was last modified |
|
||||
|
||||
### Allowed Include Paths
|
||||
|
||||
* anime
|
||||
* image
|
||||
|
||||
### Endpoints
|
||||
|
||||
**[Anime Image Destroy](/animeimage/destroy/)**
|
||||
|
||||
The anime image destroy endpoint deletes an anime image and returns the deleted anime image resource.
|
||||
|
||||
**[Anime Image Index](/animeimage/index/)**
|
||||
|
||||
The anime image index endpoint displays a listing of anime image resources.
|
||||
|
||||
**[Anime Image Show](/animeimage/show/)**
|
||||
|
||||
The anime image show endpoint returns an anime image resource.
|
||||
|
||||
**[Anime Image Store](/animeimage/store/)**
|
||||
|
||||
The anime image store endpoint creates a new anime image and returns the new anime image resource.
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Anime Image Destroy
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Image Destroy Endpoint
|
||||
|
||||
The anime image destroy endpoint deletes an anime image and returns the deleted anime image resource.
|
||||
|
||||
For example, the `/animeimage/bakemonogatari/435` endpoint will delete the association between the Bakemonogatari anime and the large cover image of id 435.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /animeimage/{anime:slug}/{image:id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: delete anime, delete image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
None
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
animeimage: {
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeimage/bakemonogatari/435
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: Anime Image Index
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Image Index Endpoint
|
||||
|
||||
The anime image index endpoint returns a listing of anime image resources.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /animeimage/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
None
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Required | Description |
|
||||
| :----------: | :------: | :---------------------------------------------------------------------------------- |
|
||||
| fields | No | Sparse fieldsets for resource types |
|
||||
| filter | No | Filters for anime image resources & constraining the inclusion of related resources |
|
||||
| include | No | Inclusion of related resources |
|
||||
| page[number] | No | The page of anime image resources to display |
|
||||
| page[size] | No | The number of anime image resources to display for the current page |
|
||||
| sort | No | The list of fields to sort the resources |
|
||||
|
||||
## Allowed Sort Fields
|
||||
|
||||
| Name | Description |
|
||||
| :--------: | :------------------------------------------------ |
|
||||
| created_at | Sort resources on the resource creation date |
|
||||
| updated_at | Sort resources on the resource last modified date |
|
||||
|
||||
## Filters
|
||||
|
||||
| Name | Description |
|
||||
| :--------: | :--------------------------------------------------------- |
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
animeimages: [
|
||||
{
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at"
|
||||
},
|
||||
...
|
||||
],
|
||||
links: {
|
||||
first: "first",
|
||||
last: "last",
|
||||
prev: "prev",
|
||||
next: "next"
|
||||
},
|
||||
meta: {
|
||||
current_page: current_page,
|
||||
from: from,
|
||||
path: "path",
|
||||
per_page: per_page,
|
||||
to: to
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animeimage/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: Anime Image Show
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Image Show Endpoint
|
||||
|
||||
The anime image show endpoint returns an anime image resource.
|
||||
|
||||
For example, the `/animeimage/bakemonogatari/435` endpoint will return the anime image resource for the association between the Bakemonogatari anime and the large cover image of id 435.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /animeimage/{anime:slug}/{image:id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
None
|
||||
|
||||
## Parameters
|
||||
|
||||
None
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
animeimage: {
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl https://api.animethemes.moe/animeimage/bakemonogatari/435
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Anime Image Store
|
||||
---
|
||||
|
||||
<Block>
|
||||
|
||||
# Anime Image Store Endpoint
|
||||
|
||||
The anime image store endpoint creates a new anime image and returns the new anime image resource.
|
||||
|
||||
For example, the `/animeimage?anime_id=218&image_id=435` endpoint will create a new association between the Bakemonogatari anime and the large cover image of id 435.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /animeimage
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: create anime, create image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Required | Rules |
|
||||
| :------: | :------: | :----------------------- |
|
||||
| anime_id | Yes | integer, Anime ID exists |
|
||||
| image_id | Yes | integer, Image ID exists |
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
animeimage: {
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Example>
|
||||
|
||||
<CURL>
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeimage/
|
||||
```
|
||||
</CURL>
|
||||
|
||||
</Example>
|
||||
|
||||
</Block>
|
||||
@@ -8,12 +8,12 @@ title: Anime Synonym Destroy
|
||||
|
||||
The anime synonym destroy endpoint soft deletes an anime synonym and returns the deleted anime synonym resource.
|
||||
|
||||
For example, the `/api/animesynonym/1523` endpoint will soft delete the Monstory synonym for the Bakemonogatari anime and return the deleted anime synonym resource.
|
||||
For example, the `/animesynonym/1523` endpoint will soft delete the Monstory synonym for the Bakemonogatari anime and return the deleted anime synonym resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/animesynonym/{id}
|
||||
DELETE /animesynonym/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Synonym Force Delete
|
||||
|
||||
The anime synonym force delete endpoint hard deletes an anime synonym and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/animesynonym/1523` endpoint will hard delete the Monstory synonym for the Bakemonogatari anime and return a confirmation message.
|
||||
For example, the `/forceDelete/animesynonym/1523` endpoint will hard delete the Monstory synonym for the Bakemonogatari anime and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/animesynonym/{id}
|
||||
DELETE /forceDelete/animesynonym/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The anime synonym index endpoint returns a listing of anime synonym resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/animesynonym/
|
||||
GET /animesynonym/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Synonym Show
|
||||
|
||||
The anime synonym show endpoint returns an anime synonym resource.
|
||||
|
||||
For example, the `/api/animesynonym/1523` endpoint will return the Monstory synonym for the anime Bakemonogatari.
|
||||
For example, the `/animesynonym/1523` endpoint will return the Monstory synonym for the anime Bakemonogatari.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/animesynonym/{id}
|
||||
GET /animesynonym/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Synonym Store
|
||||
|
||||
The anime synonym store endpoint creates a new anime synonym and returns the new anime synonym resource.
|
||||
|
||||
For example, the `/api/animesynonym?anime_id=218&text=Monstory` endpoint will create a new Monstory synonym for the Bakemonogatari anime and return the new anime synonym resource.
|
||||
For example, the `/animesynonym?anime_id=218&text=Monstory` endpoint will create a new Monstory synonym for the Bakemonogatari anime and return the new anime synonym resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/animesynonym
|
||||
POST /animesynonym
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Synonym Update
|
||||
|
||||
The anime synonym update endpoint updates an anime synonym and returns the updated anime synonym resource.
|
||||
|
||||
For example, the `/api/animesynonym/1523?text=Monstory` endpoint will update the Monstory anime synonym text attribute and return the updated anime synonym resource.
|
||||
For example, the `/animesynonym/1523?text=Monstory` endpoint will update the Monstory anime synonym text attribute and return the updated anime synonym resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/animesynonym/{id}
|
||||
PUT|PATCH /animesynonym/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Destroy
|
||||
|
||||
The anime theme destroy endpoint soft deletes an anime theme and returns the deleted anime theme resource.
|
||||
|
||||
For example, the `/api/animetheme/3373` endpoint will soft delete the OP1 theme for the Bakemonogatari anime and return the deleted anime theme resource.
|
||||
For example, the `/animetheme/3373` endpoint will soft delete the OP1 theme for the Bakemonogatari anime and return the deleted anime theme resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/animetheme/{id}
|
||||
DELETE /animetheme/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Force Delete
|
||||
|
||||
The anime theme force delete endpoint hard deletes an anime theme and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/animetheme/3373` endpoint will hard delete the OP1 theme for the Bakemonogatari anime and return a confirmation message.
|
||||
For example, the `/forceDelete/animetheme/3373` endpoint will hard delete the OP1 theme for the Bakemonogatari anime and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/animetheme/{id}
|
||||
DELETE /forceDelete/animetheme/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The anime theme index endpoint returns a listing of anime theme resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/animetheme/
|
||||
GET /animetheme/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Show
|
||||
|
||||
The anime theme show endpoint returns an anime theme resource.
|
||||
|
||||
For example, the `/api/animetheme/3373` endpoint will return the OP1 anime theme resource for the Bakemonogatari anime.
|
||||
For example, the `/animetheme/3373` endpoint will return the OP1 anime theme resource for the Bakemonogatari anime.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/animetheme/{id}
|
||||
GET /animetheme/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Store
|
||||
|
||||
The anime theme store endpoint creates a new anime theme and returns the new anime theme resource.
|
||||
|
||||
For example, the `/api/animetheme?anime_id=218&type=OP&sequence=1&slug=OP1` endpoint will create a new OP1 theme for the Bakemonogatari anime and return the new anime theme resource.
|
||||
For example, the `/animetheme?anime_id=218&type=OP&sequence=1&slug=OP1` endpoint will create a new OP1 theme for the Bakemonogatari anime and return the new anime theme resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/animetheme
|
||||
POST /animetheme
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Update
|
||||
|
||||
The anime theme update endpoint updates an anime theme and returns the updated anime theme resource.
|
||||
|
||||
For example, the `/api/animetheme/3373?song_id=3373` endpoint will update the song_id attribute of the OP1 theme for the Bakemonogatari anime and return the updated anime theme resource.
|
||||
For example, the `/animetheme/3373?song_id=3373` endpoint will update the song_id attribute of the OP1 theme for the Bakemonogatari anime and return the updated anime theme resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/animetheme/{id}
|
||||
PUT|PATCH /animetheme/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Entry Destroy
|
||||
|
||||
The anime theme entry destroy endpoint soft deletes an anime theme entry and returns the deleted anime theme entry resource.
|
||||
|
||||
For example, the `/api/animethemeentry/3822` endpoint will soft delete the V2 entry for the ED1 theme of the Bakemonogatari anime and return the deleted anime theme entry resource.
|
||||
For example, the `/animethemeentry/3822` endpoint will soft delete the V2 entry for the ED1 theme of the Bakemonogatari anime and return the deleted anime theme entry resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/animethemeentry/{id}
|
||||
DELETE /animethemeentry/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Entry Force Delete
|
||||
|
||||
The anime theme entry force delete endpoint hard deletes an anime theme entry and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/animethemeentry/3822` endpoint will hard delete the V2 entry for the ED theme of the Bakemonogatari anime and return a confirmation message.
|
||||
For example, the `/forceDelete/animethemeentry/3822` endpoint will hard delete the V2 entry for the ED theme of the Bakemonogatari anime and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/animethemeentry/{id}
|
||||
DELETE /forceDelete/animethemeentry/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The anime theme entry index endpoint returns a listing of anime theme entry reso
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/animethemeentry/
|
||||
GET /animethemeentry/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Entry Show
|
||||
|
||||
The anime theme entry show endpoint returns an anime theme entry resource.
|
||||
|
||||
For example, the `/api/animethemeentry/3822` endpoint will return the V2 entry for the ED theme of the Bakemonogatari anime.
|
||||
For example, the `/animethemeentry/3822` endpoint will return the V2 entry for the ED theme of the Bakemonogatari anime.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/animethemeentry/{id}
|
||||
GET /animethemeentry/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Entry Store
|
||||
|
||||
The anime theme entry store endpoint creates a new anime theme entry and returns the new anime theme entry resource.
|
||||
|
||||
For example, the `/api/animethemeentry?theme_id=3378&version=2` endpoint will create a new V2 entry for the ED theme of the Bakemonogatari anime and return the new anime theme resource.
|
||||
For example, the `/animethemeentry?theme_id=3378&version=2` endpoint will create a new V2 entry for the ED theme of the Bakemonogatari anime and return the new anime theme resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/animethemeentry
|
||||
POST /animethemeentry
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Anime Theme Entry Update
|
||||
|
||||
The anime theme entry update endpoint updates an anime theme entry and returns the updated anime theme entry resource.
|
||||
|
||||
For example, the `/api/animethemeentry/3822?episodes=11-14` endpoint will update the episodes attribute of the V2 entry for the ED theme of the Bakemonogatari anime and return the updated anime theme entry resource.
|
||||
For example, the `/animethemeentry/3822?episodes=11-14` endpoint will update the episodes attribute of the V2 entry for the ED theme of the Bakemonogatari anime and return the updated anime theme entry resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/animethemeentry/{id}
|
||||
PUT|PATCH /animethemeentry/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The year index endpoint returns a list of unique years from all anime resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/animeyear/
|
||||
GET /animeyear/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Year Show
|
||||
|
||||
The year show endpoint return a listing of anime resources for a given year grouped by season and ordered by name.
|
||||
|
||||
For example, the `/api/animeyear/2000` endpoint will return a listing of anime resources of year 2000 grouped by season and ordered by name.
|
||||
For example, the `/animeyear/2000` endpoint will return a listing of anime resources of year 2000 grouped by season and ordered by name.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/animeyear/{year}
|
||||
GET /animeyear/{year}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Announcement Destroy
|
||||
|
||||
The announcement destroy endpoint soft deletes an announcement and returns the deleted announcement resource.
|
||||
|
||||
For example, the `/api/announcement/1` endpoint will soft delete the announcement of id '1' and return the deleted announcement resource.
|
||||
For example, the `/announcement/1` endpoint will soft delete the announcement of id '1' and return the deleted announcement resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/announcement/{id}
|
||||
DELETE /announcement/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Announcement Force Delete
|
||||
|
||||
The announcement force delete endpoint hard deletes an announcement and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/announcement/1` endpoint will hard delete the announcement of id '1' and return a confirmation message.
|
||||
For example, the `/forceDelete/announcement/1` endpoint will hard delete the announcement of id '1' and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/announcement/{id}
|
||||
DELETE /forceDelete/announcement/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The announcement index endpoint returns a listing of announcement resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/announcement/
|
||||
GET /announcement/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The announcement show endpoint returns an announcement resource.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/announcement/{id}
|
||||
GET /announcement/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Announcement Store
|
||||
|
||||
The announcement store endpoint creates a new announcement and returns the new announcement resource.
|
||||
|
||||
For example, the `/api/announcement?content=Lorem+Ipsum` endpoint will create a new announcement and return the new announcement resource.
|
||||
For example, the `/announcement?content=Lorem+Ipsum` endpoint will create a new announcement and return the new announcement resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/announcement
|
||||
POST /announcement
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Announcement Update
|
||||
|
||||
The announcement update endpoint updates an announcement and returns the updated announcement resource.
|
||||
|
||||
For example, the `/api/announcement/1?content=The+Release+Has+Been+Deployed!` endpoint will update the announcement content attribute and return the updated announcement resource.
|
||||
For example, the `/announcement/1?content=The+Release+Has+Been+Deployed!` endpoint will update the announcement content attribute and return the updated announcement resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/announcement/{id}
|
||||
PUT|PATCH /announcement/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Artist Destroy
|
||||
|
||||
The artist destroy endpoint soft deletes an artist and returns the deleted artist resource.
|
||||
|
||||
For example, the `/api/artist/chiwa_saito` endpoint will soft delete the Chiwa Saito artist and return the deleted Chiwa Saito resource.
|
||||
For example, the `/artist/chiwa_saito` endpoint will soft delete the Chiwa Saito artist and return the deleted Chiwa Saito resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/artist/{slug}
|
||||
DELETE /artist/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Artist Force Delete
|
||||
|
||||
The artist force delete endpoint hard deletes an artist and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/artist/chiwa_saito` endpoint will hard delete the Chiwa Saito artist and return a confirmation message.
|
||||
For example, the `/forceDelete/artist/chiwa_saito` endpoint will hard delete the Chiwa Saito artist and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/artist/{slug}
|
||||
DELETE /forceDelete/artist/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The artist index endpoint returns a listing of artist resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/artist/
|
||||
GET /artist/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Artist Show
|
||||
|
||||
The artist show endpoint returns an artist resource.
|
||||
|
||||
For example, the `/api/artist/chiwa_saito` endpoint will return the artist resource for the artist Chiwa Saito.
|
||||
For example, the `/artist/chiwa_saito` endpoint will return the artist resource for the artist Chiwa Saito.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/artist/{slug}
|
||||
GET /artist/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Artist Store
|
||||
|
||||
The artist store endpoint creates a new artist and returns the new artist resource.
|
||||
|
||||
For example, the `/api/artist?name=Chiwa+Saito&slug=chiwa_saito` endpoint will create a new Chiwa Saito artist and return the new Chiwa Saito resource.
|
||||
For example, the `/artist?name=Chiwa+Saito&slug=chiwa_saito` endpoint will create a new Chiwa Saito artist and return the new Chiwa Saito resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/artist
|
||||
POST /artist
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Artist Update
|
||||
|
||||
The artist update endpoint updates an artist and returns the updated artist resource.
|
||||
|
||||
For example, the `/api/artist/chiwa_saito?name=Chiwa+Saito` endpoint will update the Chiwa Saito artist name attribute and return the updated Chiwa Saito resource.
|
||||
For example, the `/artist/chiwa_saito?name=Chiwa+Saito` endpoint will update the Chiwa Saito artist name attribute and return the updated Chiwa Saito resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/artist/{slug}
|
||||
PUT|PATCH /artist/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Balance Destroy
|
||||
|
||||
The balance destroy endpoint soft deletes a balance and returns the deleted balance resource.
|
||||
|
||||
For example, the `/api/balance/1` endpoint will soft delete the balance of id '1' and return the deleted balance resource.
|
||||
For example, the `/balance/1` endpoint will soft delete the balance of id '1' and return the deleted balance resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/balance/{id}
|
||||
DELETE /balance/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Balance Force Delete
|
||||
|
||||
The balance force delete endpoint hard deletes a balance and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/balance/1` endpoint will hard delete the balance of id '1' and return a confirmation message.
|
||||
For example, the `/forceDelete/balance/1` endpoint will hard delete the balance of id '1' and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/balance/{id}
|
||||
DELETE /forceDelete/balance/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The balance index endpoint returns a listing of balance resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/balance/
|
||||
GET /balance/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The balance show endpoint returns a balance resource.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/balance/{id}
|
||||
GET /balance/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Balance Store
|
||||
|
||||
The balance store endpoint creates a new balance and returns the new balance resource.
|
||||
|
||||
For example, the `/api/balance?date=2022-06-01&service=AWS&frequency=Monthly&usage=10.00&month_to_date_balance=50.00` endpoint will create a new balance and return the new balance resource.
|
||||
For example, the `/balance?date=2022-06-01&service=AWS&frequency=Monthly&usage=10.00&month_to_date_balance=50.00` endpoint will create a new balance and return the new balance resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/balance
|
||||
POST /balance
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Balance Update
|
||||
|
||||
The balance update endpoint updates a balance and returns the updated balance resource.
|
||||
|
||||
For example, the `/api/balance/1?usage=10.00` endpoint will update the balance usage attribute and return the updated balance resource.
|
||||
For example, the `/balance/1?usage=10.00` endpoint will update the balance usage attribute and return the updated balance resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/balance/{id}
|
||||
PUT|PATCH /balance/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The flags show endpoint returns the flags resource.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/config/flags
|
||||
GET /config/flags
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The wiki show endpoint returns the wiki resource.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/config/wiki
|
||||
GET /config/wiki
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Image Destroy
|
||||
|
||||
The image destroy endpoint soft deletes an image and returns the deleted image resource.
|
||||
|
||||
For example, the `/api/image/435` endpoint will soft delete the large cover image for the Bakemonogatari anime and return the deleted image resource.
|
||||
For example, the `/image/435` endpoint will soft delete the large cover image for the Bakemonogatari anime and return the deleted image resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/image/{id}
|
||||
DELETE /image/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Image Force Delete
|
||||
|
||||
The image force delete endpoint hard deletes an image resource and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/image/435` endpoint will hard delete the large cover image for the Bakemonogatari anime and return a confirmation message.
|
||||
For example, the `/forceDelete/image/435` endpoint will hard delete the large cover image for the Bakemonogatari anime and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/image/{id}
|
||||
DELETE /forceDelete/image/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The image index endpoint returns a listing of image resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/image/
|
||||
GET /image/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Image Show
|
||||
|
||||
The image show endpoint returns an image resource.
|
||||
|
||||
For example, `/api/image/435` endpoint will return the large cover image for the Bakemonogatari anime.
|
||||
For example, `/image/435` endpoint will return the large cover image for the Bakemonogatari anime.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/image/{id}
|
||||
GET /image/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Image Store
|
||||
|
||||
The image store endpoint creates a new image and returns the new image resource.
|
||||
|
||||
For example, the `/api/image?facet=large+cover` endpoint will create a new large cover image for the Bakemonogatari anime and return the new image resource.
|
||||
For example, the `/image?facet=large+cover` endpoint will create a new large cover image for the Bakemonogatari anime and return the new image resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/image
|
||||
POST /image
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Image Update
|
||||
|
||||
The image update endpoint updates an image and returns the updated image resource.
|
||||
|
||||
For example, the `/api/image?facet=large+cover` endpoint will update the image facet attribute and return the updated image resource.
|
||||
For example, the `/image?facet=large+cover` endpoint will update the image facet attribute and return the updated image resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/image/{id}
|
||||
PUT|PATCH /image/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
+31
-31
@@ -166,7 +166,7 @@ The AnimeThemes API does **NOT** support fetching resources or relationships.
|
||||
The AnimeThemes API supports inclusion of related resources for every endpoint unless otherwise specified.
|
||||
|
||||
```json
|
||||
// /api/anime/{slug}?include=animethemes,series
|
||||
// /anime/{slug}?include=animethemes,series
|
||||
{
|
||||
anime: {
|
||||
...
|
||||
@@ -183,7 +183,7 @@ The AnimeThemes API supports inclusion of related resources for every endpoint u
|
||||
For endpoints that produce responses of mixed typed top-level members, inclusion of related resources are scoped by type `include[type]`.
|
||||
|
||||
```json
|
||||
// /api/search?q={query}&include[anime]=resources
|
||||
// /search?q={query}&include[anime]=resources
|
||||
{
|
||||
search: {
|
||||
anime: [
|
||||
@@ -203,7 +203,7 @@ For endpoints that produce responses of mixed typed top-level members, inclusion
|
||||
If inclusion of related resources is not specified, the AnimeThemes API shall **NOT** include any related resources.
|
||||
|
||||
```json
|
||||
// /api/anime/{slug}
|
||||
// /anime/{slug}
|
||||
// No relationships are included by default
|
||||
{
|
||||
anime: {
|
||||
@@ -225,7 +225,7 @@ If inclusion of related resources is not specified, the AnimeThemes API shall **
|
||||
The AnimeThemes API supports sparse fieldsets for every endpoint unless otherwise specified.
|
||||
|
||||
```json
|
||||
// /api/anime/{slug}?fields[anime]=name,year
|
||||
// /anime/{slug}?fields[anime]=name,year
|
||||
{
|
||||
anime: {
|
||||
name: "name",
|
||||
@@ -237,7 +237,7 @@ The AnimeThemes API supports sparse fieldsets for every endpoint unless otherwis
|
||||
If the client does not specify the set of fields for a given resource type, the AnimeThemes API shall send all fields.
|
||||
|
||||
```json
|
||||
// /api/anime/{slug}
|
||||
// /anime/{slug}
|
||||
{
|
||||
anime: {
|
||||
id: id,
|
||||
@@ -258,7 +258,7 @@ If the client does not specify the set of fields for a given resource type, the
|
||||
The AnimeThemes API supports sorting for every endpoint that returns a collection of resources.
|
||||
|
||||
```json
|
||||
// /api/anime?sort=year
|
||||
// /anime?sort=year
|
||||
{
|
||||
anime: [
|
||||
{
|
||||
@@ -295,7 +295,7 @@ The AnimeThemes API supports sorting for every endpoint that returns a collectio
|
||||
The AnimeThemes API supports an offset pagination strategy for every endpoint that returns a collection of resources. For these endpoints, the AnimeThemes API supports the `page[number]` and `page[size]` query parameters.
|
||||
|
||||
```json
|
||||
// /api/anime?page[number]=2&page[size]=15
|
||||
// /anime?page[number]=2&page[size]=15
|
||||
{
|
||||
anime: [
|
||||
{
|
||||
@@ -330,7 +330,7 @@ The AnimeThemes API supports an offset pagination strategy for every endpoint th
|
||||
For endpoints that produce responses of mixed typed top-level members, the AnimeThemes.moe supports a limit pagination strategy. For these endpoints, the AnimeThemes API support the `page[limit]` query parameter.
|
||||
|
||||
```json
|
||||
// /api/search?q={query}&page[limit]=1
|
||||
// /search?q={query}&page[limit]=1
|
||||
{
|
||||
search: {
|
||||
anime: [
|
||||
@@ -352,7 +352,7 @@ The AnimeThemes API supports filtering for every endpoint unless otherwise speci
|
||||
|
||||
```powershell
|
||||
# The show anime endpoint allows filtering on the year attribute, for example
|
||||
/api/anime?filter[year]=2000
|
||||
/anime?filter[year]=2000
|
||||
```
|
||||
|
||||
**Strategy**
|
||||
@@ -369,14 +369,14 @@ The AnimeThemes API supports scoping filters by resource type.
|
||||
|
||||
```powershell
|
||||
# This will match the created_at filter for anime resources and will not apply the filter for other types
|
||||
/api/anime?filter[anime][created_at]=2021-01-01
|
||||
/anime?filter[anime][created_at]=2021-01-01
|
||||
```
|
||||
|
||||
If a scope is not provided, the filter shall match all types.
|
||||
|
||||
```powershell
|
||||
# This will match the created_at filter for all types
|
||||
/api/anime?filter[created_at]=2021-01-01
|
||||
/anime?filter[created_at]=2021-01-01
|
||||
```
|
||||
|
||||
**Comparison Operator**
|
||||
@@ -387,63 +387,63 @@ EQ
|
||||
|
||||
```powershell
|
||||
# This will match anime of year 2000
|
||||
/api/anime?filter[year-eq]=2000
|
||||
/anime?filter[year-eq]=2000
|
||||
```
|
||||
|
||||
NE
|
||||
|
||||
```powershell
|
||||
# This will match anime not of year 2000
|
||||
/api/anime?filter[year-ne]=2000
|
||||
/anime?filter[year-ne]=2000
|
||||
```
|
||||
|
||||
LT
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is less than 2000
|
||||
/api/anime?filter[year-lt]=2000
|
||||
/anime?filter[year-lt]=2000
|
||||
```
|
||||
|
||||
GT
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is greater than 2000
|
||||
/api/anime?filter[year-gt]=2000
|
||||
/anime?filter[year-gt]=2000
|
||||
```
|
||||
|
||||
LTE
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is less than or equal to 2000
|
||||
/api/anime?filter[year-lte]=2000
|
||||
/anime?filter[year-lte]=2000
|
||||
```
|
||||
|
||||
GTE
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is greater than 2000
|
||||
/api/anime?filter[year-gte]=2000
|
||||
/anime?filter[year-gte]=2000
|
||||
```
|
||||
|
||||
LIKE
|
||||
|
||||
```powershell
|
||||
# This will match anime where the name matches the pattern '%monogatari%'
|
||||
/api/anime?filter[name-like]=%monogatari%
|
||||
/anime?filter[name-like]=%monogatari%
|
||||
```
|
||||
|
||||
NOT LIKE
|
||||
|
||||
```powershell
|
||||
# This will match anime where the name does not match the pattern '%monogatari%'
|
||||
/api/anime?filter[name-notlike]=%monogatari%
|
||||
/anime?filter[name-notlike]=%monogatari%
|
||||
```
|
||||
|
||||
If a comparison operator is not provided, the filter shall use the EQ operator.
|
||||
|
||||
```powershell
|
||||
# This will match anime of year 2000
|
||||
/api/anime?filter[year]=2000
|
||||
/anime?filter[year]=2000
|
||||
```
|
||||
|
||||
**Logical Operators**
|
||||
@@ -454,21 +454,21 @@ AND
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is greater than 2000 and less than 2010
|
||||
/api/anime?filter[year-gt-and]=2000&filter[year-lt-and]=2010
|
||||
/anime?filter[year-gt-and]=2000&filter[year-lt-and]=2010
|
||||
```
|
||||
|
||||
OR
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is less than 2000 or greater than 2010
|
||||
/api/anime?filter[year-lt-or]=2000&filter[year-gt-or]=2010
|
||||
/anime?filter[year-lt-or]=2000&filter[year-gt-or]=2010
|
||||
```
|
||||
|
||||
If a logical operator is not provided, the filter shall use the AND operator.
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is greater than 2000 and less than 2010
|
||||
/api/anime?filter[year-gt]=2000&filter[year-lt]=2010
|
||||
/anime?filter[year-gt]=2000&filter[year-lt]=2010
|
||||
```
|
||||
|
||||
The AnimeThemes API supports the following logical operator for multi-value filter conditions:
|
||||
@@ -477,14 +477,14 @@ NOT
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is not in {2000,2001,2002}
|
||||
/api/anime?filter[year-not]=2000,2001,2002
|
||||
/anime?filter[year-not]=2000,2001,2002
|
||||
```
|
||||
|
||||
If the multi-value logical operator is not specified, the filter shall exclude the multi-value logical operator.
|
||||
|
||||
```powershell
|
||||
# This will match anime where the year is in {2000,2001,2002}
|
||||
/api/anime?filter[year]=2000,2001,2002
|
||||
/anime?filter[year]=2000,2001,2002
|
||||
```
|
||||
|
||||
**Special Filters**
|
||||
@@ -493,33 +493,33 @@ Trashed Filter
|
||||
|
||||
```powershell
|
||||
# This filter will include soft-deleted anime that are excluded by default
|
||||
/api/anime?filter[trashed]=with
|
||||
/anime?filter[trashed]=with
|
||||
```
|
||||
|
||||
```powershell
|
||||
# This filter will return only soft-deleted anime
|
||||
/api/anime?filter[trashed]=only
|
||||
/anime?filter[trashed]=only
|
||||
```
|
||||
|
||||
```powershell
|
||||
# This filter will return only anime that are not soft-deleted
|
||||
# This is the default behavior
|
||||
/api/anime?filter[trashed]=without
|
||||
/anime?filter[trashed]=without
|
||||
```
|
||||
|
||||
Has Filter
|
||||
|
||||
```powershell
|
||||
# This filter will return anime that have at least one related resource
|
||||
/api/anime?filter[has]=resources
|
||||
/anime?filter[has]=resources
|
||||
```
|
||||
|
||||
```powershell
|
||||
# This filter will return anime that have at least one related resource or related series
|
||||
/api/anime?filter[has-or]=resources,series
|
||||
/anime?filter[has-or]=resources,series
|
||||
```
|
||||
|
||||
```powershell
|
||||
# This filter will return anime that have at least one related resource of site MyAnimeList and external_id 41457
|
||||
/api/anime?filter[has]=resources&filter[site]=MyAnimeList&filter[external_id]=41457
|
||||
/anime?filter[has]=resources&filter[site]=MyAnimeList&filter[external_id]=41457
|
||||
```
|
||||
@@ -8,12 +8,12 @@ title: Page Destroy
|
||||
|
||||
The page destroy endpoint soft deletes a page and returns the deleted page resource.
|
||||
|
||||
For example, the `/api/page/encoding` endpoint will soft delete the Encoding page and return the deleted Encoding resource.
|
||||
For example, the `/page/encoding` endpoint will soft delete the Encoding page and return the deleted Encoding resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/page/{slug}
|
||||
DELETE /page/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Page Force Delete
|
||||
|
||||
The page force delete endpoint hard deletes a page and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/page/encoding` endpoint will hard delete the Encoding page and return a confirmation message.
|
||||
For example, the `/forceDelete/page/encoding` endpoint will hard delete the Encoding page and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/page/{slug}
|
||||
DELETE /forceDelete/page/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The page index endpoint returns a listing of page resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/page/
|
||||
GET /page/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Page Show
|
||||
|
||||
The page show endpoint returns a page resource.
|
||||
|
||||
For example, the `/api/page/encoding` endpoint will return the Encoding page resource.
|
||||
For example, the `/page/encoding` endpoint will return the Encoding page resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/page/{slug}
|
||||
GET /page/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Page Store
|
||||
|
||||
The page store endpoint creates a new page and returns the new page resource.
|
||||
|
||||
For example, the `/api/page?name=Encoding&slug=encoding&body=Lorem+Ipsum` endpoint will create a new Encoding page and return the new Encoding resource.
|
||||
For example, the `/page?name=Encoding&slug=encoding&body=Lorem+Ipsum` endpoint will create a new Encoding page and return the new Encoding resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/page
|
||||
POST /page
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Page Update
|
||||
|
||||
The page update endpoint updates a page and returns the updated page resource.
|
||||
|
||||
For example, the `/api/page/encoding?body=Lorem+Ipsum` endpoint will update the Encoding page body attribute and return the updated Encoding resource.
|
||||
For example, the `/page/encoding?body=Lorem+Ipsum` endpoint will update the Encoding page body attribute and return the updated Encoding resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/page/{slug}
|
||||
PUT|PATCH /page/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Resource Destroy
|
||||
|
||||
The resource destroy endpoint soft deletes an external resource and returns the deleted external resource.
|
||||
|
||||
For example, the `/api/resource/1083` endpoint will soft delete the MyAnimeList resource for the Bakemonogatari anime and return the deleted MyAnimeList resource.
|
||||
For example, the `/resource/1083` endpoint will soft delete the MyAnimeList resource for the Bakemonogatari anime and return the deleted MyAnimeList resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/resource/{id}
|
||||
DELETE /resource/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Resource Force Delete
|
||||
|
||||
The resource force delete endpoint hard deletes an external resource and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/resource/1083` endpoint will hard delete the MyAnimeList resource for the Bakemonogatari anime and return a confirmation message.
|
||||
For example, the `/forceDelete/resource/1083` endpoint will hard delete the MyAnimeList resource for the Bakemonogatari anime and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/resource/{id}
|
||||
DELETE /forceDelete/resource/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The resource index endpoint returns a listing of external resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/resource/
|
||||
GET /resource/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Resource Show
|
||||
|
||||
The resource show endpoint returns an external resource.
|
||||
|
||||
For example, the `/api/resource/1083` will return the MyAnimeList resource for the Bakemonogatari anime.
|
||||
For example, the `/resource/1083` will return the MyAnimeList resource for the Bakemonogatari anime.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/resource/{id}
|
||||
GET /resource/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Resource Store
|
||||
|
||||
The resource store endpoint creates a new external resource and returns the new external resource.
|
||||
|
||||
For example, the `/api/resource?link=https%3A%2F%2Fmyanimelist.net%2Fanime%2F5081%2F&site=MyAnimeList` endpoint will create a new MyAnimeList resource for the Bakemonogatari anime and return the new MyAnimeList resource.
|
||||
For example, the `/resource?link=https%3A%2F%2Fmyanimelist.net%2Fanime%2F5081%2F&site=MyAnimeList` endpoint will create a new MyAnimeList resource for the Bakemonogatari anime and return the new MyAnimeList resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/resource
|
||||
POST /resource
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Resource Update
|
||||
|
||||
The resource update endpoint updates an external resource and returns the updated external resource.
|
||||
|
||||
For example, the `/api/resource/1083?external_id=5081` endpoint will update the external resource external_id attribute and return the updated external resource.
|
||||
For example, the `/resource/1083?external_id=5081` endpoint will update the external resource external_id attribute and return the updated external resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/resource/{id}
|
||||
PUT|PATCH /resource/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The global search endpoint returns a listing of wiki resources that match a give
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/search/
|
||||
GET /search/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Series Destroy
|
||||
|
||||
The series destroy endpoint soft deletes a series and returns the deleted series resource.
|
||||
|
||||
For example, the `/api/series/monogatari` endpoint will soft delete the Monogatari series and return the deleted Monogatari resource.
|
||||
For example, the `/series/monogatari` endpoint will soft delete the Monogatari series and return the deleted Monogatari resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/series/{slug}
|
||||
DELETE /series/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Series Force Delete
|
||||
|
||||
The series force delete endpoint hard deletes a series and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/series/monogatari` endpoint will hard delete the Monogatari series and return a confirmation message.
|
||||
For example, the `/forceDelete/series/monogatari` endpoint will hard delete the Monogatari series and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/series/{slug}
|
||||
DELETE /forceDelete/series/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The series index endpoint returns a listing of series resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/series/
|
||||
GET /series/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Series Show
|
||||
|
||||
The series show endpoint returns a series resource.
|
||||
|
||||
For example, the `/api/series/monogatari` endpoint will return the series resource for the Monogatari series.
|
||||
For example, the `/series/monogatari` endpoint will return the series resource for the Monogatari series.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/series/{slug}
|
||||
GET /series/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Series Store
|
||||
|
||||
The series store endpoint creates a new series and returns the new series resource.
|
||||
|
||||
For example, the `/api/series?name=Monogatari&slug=monogatari` endpoint will create a new Monogatari series and return the new Monogatari resource.
|
||||
For example, the `/series?name=Monogatari&slug=monogatari` endpoint will create a new Monogatari series and return the new Monogatari resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/series
|
||||
POST /series
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Series Update
|
||||
|
||||
The series update endpoint updates a series and returns the updated series resource.
|
||||
|
||||
For example, the `/api/series/monogatari?name=Monogatari` endpoint will update the Monogatari series name attribute and return the updated Monogatari resource.
|
||||
For example, the `/series/monogatari?name=Monogatari` endpoint will update the Monogatari series name attribute and return the updated Monogatari resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/series/{slug}
|
||||
PUT|PATCH /series/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Song Destroy
|
||||
|
||||
The song destroy endpoint soft deletes a song and returns the deleted song resource.
|
||||
|
||||
For example, the `/api/song/3373` endpoint will soft delete the "staple stable" song and return the deleted "staple stable" resource.
|
||||
For example, the `/song/3373` endpoint will soft delete the "staple stable" song and return the deleted "staple stable" resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/song/{id}
|
||||
DELETE /song/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Song Force Delete
|
||||
|
||||
The song force delete endpoint hard deletes a song and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/song/3373` endpoint will hard delete the "staple stable" song and return a confirmation message.
|
||||
For example, the `/forceDelete/song/3373` endpoint will hard delete the "staple stable" song and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/song/{id}
|
||||
DELETE /forceDelete/song/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The song index endpoint returns a listing of song resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/song/
|
||||
GET /song/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Song Show
|
||||
|
||||
The song show endpoint returns a song resource.
|
||||
|
||||
For example, the `/api/song/3373` endpoint will return the song resource for the Staple Stable song.
|
||||
For example, the `/song/3373` endpoint will return the song resource for the Staple Stable song.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/song/{id}
|
||||
GET /song/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Song Store
|
||||
|
||||
The song store endpoint creates a new song and returns the new song resource.
|
||||
|
||||
For example, the `/api/song?title=staple+stable` endpoint will create a new "staple stable" song and return the new "staple stable" resource.
|
||||
For example, the `/song?title=staple+stable` endpoint will create a new "staple stable" song and return the new "staple stable" resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/song
|
||||
POST /song
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Song Update
|
||||
|
||||
The song update endpoint updates a song and returns the updated song resource.
|
||||
|
||||
For example, the `/api/song/song?title=staple+stable` endpoint will update the "staple stable" song title attribute and return the updated "staple stable" resource.
|
||||
For example, the `/song/song?title=staple+stable` endpoint will update the "staple stable" song title attribute and return the updated "staple stable" resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/song/{id}
|
||||
PUT|PATCH /song/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Studio Destroy
|
||||
|
||||
The studio destroy endpoint soft deletes a studio and returns the deleted studio resource.
|
||||
|
||||
For example, the `/api/studio/shaft` endpoint will soft delete the Shaft studio and return the deleted Shaft resource.
|
||||
For example, the `/studio/shaft` endpoint will soft delete the Shaft studio and return the deleted Shaft resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/studio/{slug}
|
||||
DELETE /studio/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Studio Force Delete
|
||||
|
||||
The studio force delete endpoint hard deletes a studio and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/studio/shaft` endpoint will hard delete the Shaft studio and return a confirmation message.
|
||||
For example, the `/forceDelete/studio/shaft` endpoint will hard delete the Shaft studio and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/studio/{slug}
|
||||
DELETE /forceDelete/studio/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The studio index endpoint returns a listing of studio resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/studio/
|
||||
GET /studio/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Studio Show
|
||||
|
||||
The studio show endpoint returns a studio resource.
|
||||
|
||||
For example, the `/api/studio/shaft` endpoint will return the studio resource for the production company Shaft.
|
||||
For example, the `/studio/shaft` endpoint will return the studio resource for the production company Shaft.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/studio/{slug}
|
||||
GET /studio/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Studio Store
|
||||
|
||||
The studio store endpoint creates a new studio and returns the new studio resource.
|
||||
|
||||
For example, the `/api/studio?name=Shaft&slug=shaft` endpoint will create a new Shaft studio and return the new Shaft resource.
|
||||
For example, the `/studio?name=Shaft&slug=shaft` endpoint will create a new Shaft studio and return the new Shaft resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/studio
|
||||
POST /studio
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Studio Update
|
||||
|
||||
The studio update endpoint updates a studio and returns the updated studio resource.
|
||||
|
||||
For example, the `/api/studio/shaft?name=Shaft` endpoint will update the Shaft studio name attribute and return the updated Shaft resource.
|
||||
For example, the `/studio/shaft?name=Shaft` endpoint will update the Shaft studio name attribute and return the updated Shaft resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/studio/{slug}
|
||||
PUT|PATCH /studio/{slug}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Transaction Destroy
|
||||
|
||||
The transaction destroy endpoint soft deletes a transaction and returns the deleted transaction resource.
|
||||
|
||||
For example, the `/api/transaction/1` endpoint will soft delete the transaction of id '1' and return the deleted transaction resource.
|
||||
For example, the `/transaction/1` endpoint will soft delete the transaction of id '1' and return the deleted transaction resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/transaction/{id}
|
||||
DELETE /transaction/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Transaction Force Delete
|
||||
|
||||
The transaction force delete endpoint hard deletes a transaction and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/transaction/1` endpoint will hard delete the transaction of id '1' and return a confirmation message.
|
||||
For example, the `/forceDelete/transaction/1` endpoint will hard delete the transaction of id '1' and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/transaction/{id}
|
||||
DELETE /forceDelete/transaction/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The transaction index endpoint returns a listing of transaction resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/transaction/
|
||||
GET /transaction/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The transaction show endpoint returns a transaction resource.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/transaction/{id}
|
||||
GET /transaction/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Transaction Store
|
||||
|
||||
The transaction store endpoint creates a new transaction and returns the new transaction resource.
|
||||
|
||||
For example, the `/api/transaction?date=2022-06-01&service=AWS&description=June+2022+Payment&amount=10.00` endpoint will create a new transaction and return the new transaction resource.
|
||||
For example, the `/transaction?date=2022-06-01&service=AWS&description=June+2022+Payment&amount=10.00` endpoint will create a new transaction and return the new transaction resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /api/transaction
|
||||
POST /transaction
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Transaction Update
|
||||
|
||||
The transaction update endpoint updates a transaction and returns the updated transaction resource.
|
||||
|
||||
For example, the `/api/transaction/1?external_id=12345` endpoint will update the transaction external_id attribute and return the updated transaction resource.
|
||||
For example, the `/transaction/1?external_id=12345` endpoint will update the transaction external_id attribute and return the updated transaction resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /api/transaction/{id}
|
||||
PUT|PATCH /transaction/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -16,14 +16,14 @@ If the parameter field-value pair passes every rule, the pair is considered vali
|
||||
|
||||
```powershell
|
||||
# Integer values are valid for the Anime Year Filter
|
||||
/api/anime?filter[year]=2000
|
||||
/anime?filter[year]=2000
|
||||
```
|
||||
|
||||
If the parameter field-value pair fails any rule, the pair is considered invalid.
|
||||
|
||||
```powershell
|
||||
# String values are not valid for the Anime Year Filter
|
||||
/api/anime?filter[year]=current
|
||||
/anime?filter[year]=current
|
||||
```
|
||||
|
||||
## Response
|
||||
@@ -31,7 +31,7 @@ If the parameter field-value pair fails any rule, the pair is considered invalid
|
||||
If every field-value pair is valid, the request will be executed normally.
|
||||
|
||||
```powershell
|
||||
/api/anime?filter[year]=2000&filter[season]=winter
|
||||
/anime?filter[year]=2000&filter[season]=winter
|
||||
```
|
||||
|
||||
```json
|
||||
@@ -53,7 +53,7 @@ If every field-value pair is valid, the request will be executed normally.
|
||||
If any field-value pair is invalid, the request will return a list of validation errors.
|
||||
|
||||
```powershell
|
||||
/api/anime?filter[year]=current&filter[season]=autumn
|
||||
/anime?filter[year]=current&filter[season]=autumn
|
||||
```
|
||||
|
||||
```json
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Video Destroy
|
||||
|
||||
The video destroy endpoint soft deletes a video and returns the deleted video resource.
|
||||
|
||||
For example, the `/api/video/Bakemonogatari-OP1.webm` endpoint will soft delete the Bakemonogatari-OP1.webm video and return the deleted Bakemonogatari-OP1.webm resource.
|
||||
For example, the `/video/Bakemonogatari-OP1.webm` endpoint will soft delete the Bakemonogatari-OP1.webm video and return the deleted Bakemonogatari-OP1.webm resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/video/{basename}
|
||||
DELETE /video/{basename}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -8,12 +8,12 @@ title: Video Force Delete
|
||||
|
||||
The video force delete endpoint hard deletes a video and returns a confirmation message.
|
||||
|
||||
For example, the `/api/forceDelete/video/Bakemonogatari-OP1.webm` endpoint will hard delete the Bakemonogatari-OP1.webm video and return a confirmation message.
|
||||
For example, the `/forceDelete/video/Bakemonogatari-OP1.webm` endpoint will hard delete the Bakemonogatari-OP1.webm video and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /api/forceDelete/video/{basename}
|
||||
DELETE /forceDelete/video/{basename}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -11,7 +11,7 @@ The video index endpoint returns a listing of video resources.
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /api/video/
|
||||
GET /video/
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user