AnimeThemes/animethemes-api-docs
1
0
Fork 0
mirror of https://github.com/AnimeThemes/animethemes-api-docs.git synced 2026-07-11 01:34:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

clean: resource & image pivot endpoints (#121)

Browse Source
This commit is contained in:
Kyrch
2025-11-02 21:30:36 -03:00
committed by GitHub
parent f862b53a00
commit 9a8db5d4cc
46 changed files with 16 additions and 2093 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/.vitepress/config.js
+8 -45
View File
@@ -26,23 +26,14 @@ const referenceSidebarItems = [
text: 'Anime Image',
collapsed: true,
items: [
{ text: 'Resource', link: '/wiki/animeimage/' },
{ text: 'Destroy', link: '/wiki/animeimage/destroy/' },
{ text: 'Index', link: '/wiki/animeimage/index/' },
{ text: 'Show', link: '/wiki/animeimage/show/' },
{ text: 'Store', link: '/wiki/animeimage/store/' }
{ text: 'Resource', link: '/wiki/animeimage/' }
]
},
{
text: 'Anime Resource',
collapsed: true,
items: [
{ text: 'Resource', link: '/wiki/animeresource/' },
{ text: 'Destroy', link: '/wiki/animeresource/destroy/' },
{ text: 'Index', link: '/wiki/animeresource/index/' },
{ text: 'Show', link: '/wiki/animeresource/show/' },
{ text: 'Store', link: '/wiki/animeresource/store/' },
{ text: 'Update', link: '/wiki/animeresource/update/' }
{ text: 'Resource', link: '/wiki/animeresource/' }
]
},
{
@@ -138,12 +129,7 @@ const referenceSidebarItems = [
text: 'Artist Image',
collapsed: true,
items: [
{ text: 'Resource', link: '/wiki/artistimage/' },
{ text: 'Destroy', link: '/wiki/artistimage/destroy/' },
{ text: 'Index', link: '/wiki/artistimage/index/' },
{ text: 'Show', link: '/wiki/artistimage/show/' },
{ text: 'Store', link: '/wiki/artistimage/store/' },
{ text: 'Update', link: '/wiki/artistimage/update/' }
{ text: 'Resource', link: '/wiki/artistimage/' }
]
},
{
@@ -162,12 +148,7 @@ const referenceSidebarItems = [
text: 'Artist Resource',
collapsed: true,
items: [
{ text: 'Resource', link: '/wiki/artistresource/' },
{ text: 'Destroy', link: '/wiki/artistresource/destroy/' },
{ text: 'Index', link: '/wiki/artistresource/index/' },
{ text: 'Show', link: '/wiki/artistresource/show/' },
{ text: 'Store', link: '/wiki/artistresource/store/' },
{ text: 'Update', link: '/wiki/artistresource/update/' }
{ text: 'Resource', link: '/wiki/artistresource/' }
]
},
{
@@ -270,12 +251,7 @@ const referenceSidebarItems = [
text: 'Song Resource',
collapsed: true,
items: [
{ text: 'Resource', link: '/wiki/songresource/' },
{ text: 'Destroy', link: '/wiki/songresource/destroy/' },
{ text: 'Index', link: '/wiki/songresource/index/' },
{ text: 'Show', link: '/wiki/songresource/show/' },
{ text: 'Store', link: '/wiki/songresource/store/' },
{ text: 'Update', link: '/wiki/songresource/update/' }
{ text: 'Resource', link: '/wiki/songresource/' }
]
},
{
@@ -296,23 +272,14 @@ const referenceSidebarItems = [
text: 'Studio Image',
collapsed: true,
items: [
{ text: 'Resource', link: '/wiki/studioimage/' },
{ text: 'Destroy', link: '/wiki/studioimage/destroy/' },
{ text: 'Index', link: '/wiki/studioimage/index/' },
{ text: 'Show', link: '/wiki/studioimage/show/' },
{ text: 'Store', link: '/wiki/studioimage/store/' }
{ text: 'Resource', link: '/wiki/studioimage/' }
]
},
{
text: 'Studio Resource',
collapsed: true,
items: [
{ text: 'Resource', link: '/wiki/studioresource/' },
{ text: 'Destroy', link: '/wiki/studioresource/destroy/' },
{ text: 'Index', link: '/wiki/studioresource/index/' },
{ text: 'Show', link: '/wiki/studioresource/show/' },
{ text: 'Store', link: '/wiki/studioresource/store/' },
{ text: 'Update', link: '/wiki/studioresource/update/' }
{ text: 'Resource', link: '/wiki/studioresource/' }
]
},
{
@@ -486,11 +453,7 @@ const referenceSidebarItems = [
text: 'Playlist Image',
collapsed: true,
items: [
{ text: 'Resource', link: '/list/playlistimage/' },
{ text: 'Destroy', link: '/list/playlistimage/destroy/' },
{ text: 'Index', link: '/list/playlistimage/index/' },
{ text: 'Show', link: '/list/playlistimage/show/' },
{ text: 'Store', link: '/list/playlistimage/store/' }
{ text: 'Resource', link: '/list/playlistimage/' }
]
},
{
docs/jsonapi/reference/list/playlistimage/destroy/index.md
-39
View File
@@ -1,39 +0,0 @@
---
title: Playlist Image Destroy
---
# Playlist Image Destroy Endpoint
The playlist image destroy endpoint deletes a playlist image and returns the deleted playlist image resource.
For example, the `/playlistimage/N4hG/1` endpoint will delete the association between the playlist of id N4hG and the large cover image of id 1.
## URL
```sh
DELETE /playlistimage/{playlist:id}/{image:id}
```
## Authentication
**Required Permission**: delete playlist, delete image
**Other Requirements**: User must own playlist
## Parameters
None
## Response
```json
{
message: "Image 'he3aw0eD3Gm7HKHJ5DRyCWOsK1QeIG91bmUXT2CX.png' has been detached from Playlist '/r/anime's Best OPs and EDs of 2022'.",
}
```
## Example
```bash
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/playlistimage/N4hG/1
```
docs/jsonapi/reference/list/playlistimage/index.md
-23
View File
@@ -14,26 +14,3 @@ A playlist image API resource represents the association between a playlist and
| :--------: | :-----: | :------: | :-----: | :------------------------------------------- |
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
## Allowed Include Paths
* playlist
* image
## Endpoints
**[Playlist Image Destroy](/list/playlistimage/destroy/)**
The playlist image destroy endpoint deletes a playlist image and returns a confirmation message.
**[Playlist Image Index](/list/playlistimage/index/)**
The playlist image index endpoint displays a listing of playlist image resources.
**[Playlist Image Show](/list/playlistimage/show/)**
The playlist image show endpoint returns a playlist image resource.
**[Playlist Image Store](/list/playlistimage/store/)**
The playlist image store endpoint creates a new playlist image and returns the new playlist image resource.
docs/jsonapi/reference/list/playlistimage/index/index.md
-76
View File
@@ -1,76 +0,0 @@
---
title: Playlist Image Index
---
# Playlist Image Index Endpoint
The playlist image index endpoint returns a listing of playlist image resources.
## URL
```sh
GET /playlistimage/
```
## Authentication
**Required Permission**: view playlist
## Parameters
| Name | Required | Description |
| :----------: | :------: | :------------------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for playlist image resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of playlist image resources to display |
| page[size] | No | The number of playlist 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
{
playlistimages: [
{
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
```bash
curl https://api.animethemes.moe/playlistimage/
```
docs/jsonapi/reference/list/playlistimage/show/index.md
-42
View File
@@ -1,42 +0,0 @@
---
title: Playlist Image Show
---
# Playlist Image Show Endpoint
The playlist image show endpoint returns an playlist image resource.
For example, the `/playlistimage/N4hG/1` endpoint will return the playlist image resource for the association between the playlist of id N4hG and the large cover image of id 1.
## URL
```sh
GET /playlistimage/{playlist:id}/{image:id}
```
## Authentication
**Required Permission**: view playlist
**Other Requirements**: If the playlist is private, the user must own the playlist
## Parameters
None
## Response
```json
{
playlistimage: {
created_at: "created_at",
updated_at: "updated_at"
}
}
```
## Example
```bash
curl https://api.animethemes.moe/playlistimage/N4hG/1
```
docs/jsonapi/reference/list/playlistimage/store/index.md
-40
View File
@@ -1,40 +0,0 @@
---
title: Playlist Image Store
---
# Playlist Image Store Endpoint
The playlist image store endpoint creates a new playlist image and returns the new playlist image resource.
For example, the `/playlistimage/N4hG/1` endpoint will create a new association between the playlist of id N4hG and the large cover image of id 1.
## URL
```sh
POST /playlistimage/{playlist:id}/{image:id}
```
## Authentication
**Required Permission**: create playlist, create image
## Parameters
None
## Response
```json
{
playlistimage: {
created_at: "created_at",
updated_at: "updated_at"
}
}
```
## Example
```bash
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/playlistimage/N4hG/1
```
docs/jsonapi/reference/wiki/animeimage/destroy/index.md
-39
View File
@@ -1,39 +0,0 @@
---
title: Anime Image Destroy
---
# 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, Encoder, Admin
## Parameters
None
## Response
```json
{
message: "Image 'OoMI35OjrpjORDlWJvFAZzQOD0vIH1oBQClClSIU.png' has been detached from Anime 'Bakemonogatari'.",
}
```
## Example
```bash
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeimage/bakemonogatari/435
```
docs/jsonapi/reference/wiki/animeimage/index.md
-23
View File
@@ -14,26 +14,3 @@ An anime image API resource represents the association between an anime and an i
| :--------: | :-----: | :------: | :-----: | :------------------------------------------- |
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
## Allowed Include Paths
* anime
* image
## Endpoints
**[Anime Image Destroy](/wiki/animeimage/destroy/)**
The anime image destroy endpoint deletes an anime image and returns the deleted anime image resource.
**[Anime Image Index](/wiki/animeimage/index/)**
The anime image index endpoint displays a listing of anime image resources.
**[Anime Image Show](/wiki/animeimage/show/)**
The anime image show endpoint returns an anime image resource.
**[Anime Image Store](/wiki/animeimage/store/)**
The anime image store endpoint creates a new anime image and returns the new anime image resource.
docs/jsonapi/reference/wiki/animeimage/index/index.md
-76
View File
@@ -1,76 +0,0 @@
---
title: Anime Image Index
---
# 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
```bash
curl https://api.animethemes.moe/animeimage/
```
docs/jsonapi/reference/wiki/animeimage/show/index.md
-40
View File
@@ -1,40 +0,0 @@
---
title: Anime Image Show
---
# 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
```bash
curl https://api.animethemes.moe/animeimage/bakemonogatari/435
```
docs/jsonapi/reference/wiki/animeimage/store/index.md
-42
View File
@@ -1,42 +0,0 @@
---
title: Anime Image Store
---
# 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/bakemonogatari/435` endpoint will create a new association between the Bakemonogatari anime and the large cover image of id 435.
## URL
```sh
POST /animeimage/{anime:slug}/{image:id}
```
## Authentication
**Required Permission**: create anime, create image
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
None
## Response
```json
{
animeimage: {
created_at: "created_at",
updated_at: "updated_at"
}
}
```
## Example
```bash
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeimage/bakemonogatari/435
```
docs/jsonapi/reference/wiki/animeresource/destroy/index.md
-39
View File
@@ -1,39 +0,0 @@
---
title: Anime Resource Destroy
---
# Anime Resource Destroy Endpoint
The anime resource destroy endpoint deletes an anime resource and returns the deleted anime resource resource.
For example, the `/animeresource/bakemonogatari/1083` endpoint will delete the association between the Bakemonogatari anime and the external resource of id 1083.
## URL
```sh
DELETE /animeresource/{anime:slug}/{resource:id}
```
## Authentication
**Required Permission**: delete anime, delete external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
None
## Response
```json
{
message: "Resource 'https://myanimelist.net/anime/5081' has been detached from Anime 'Bakemonogatari'.",
}
```
## Example
```bash
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeresource/bakemonogatari/1083
```
docs/jsonapi/reference/wiki/animeresource/index.md
-27
View File
@@ -15,30 +15,3 @@ An anime resource API resource represents the association between an anime and a
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
| as | String | No | Yes | Used to distinguish resources that map to the same anime |
## Allowed Include Paths
* anime
* resource
## Endpoints
**[Anime Resource Destroy](/wiki/animeresource/destroy/)**
The anime resource destroy endpoint deletes an anime resource and returns the deleted anime resource resource.
**[Anime Resource Index](/wiki/animeresource/index/)**
The anime resource index endpoint displays a listing of anime resource resources.
**[Anime Resource Show](/wiki/animeresource/show/)**
The anime resource show endpoint returns an anime resource resource.
**[Anime Resource Store](/wiki/animeresource/store/)**
The anime resource store endpoint creates a new anime resource and returns the new anime resource resource.
**[Anime Resource Update](/wiki/animeresource/update/)**
The anime resource update endpoint updates an anime resource and returns the updated anime resource resource.
docs/jsonapi/reference/wiki/animeresource/index/index.md
-79
View File
@@ -1,79 +0,0 @@
---
title: Anime Resource Index
---
# Anime Resource Index Endpoint
The anime resource index endpoint returns a listing of anime resource resources.
## URL
```sh
GET /animeresource/
```
## Authentication
None
## Parameters
| 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 resource resources to display |
| page[size] | No | The number of anime resource 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 |
| as | Sort resources on distinguishing label |
## Filters
| Name | Description |
| :--------: | :--------------------------------------------------------- |
| created_at | Filter resources on the resource creation date |
| updated_at | Filter resources on the resource last modified date |
| as | Filter resources on the resource distinguishing label |
| has | Filter resources on relations within allowed include paths |
## Response
```json
{
animeresources: [
{
created_at: "created_at",
updated_at: "updated_at",
as: "as"
},
...
],
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
```bash
curl https://api.animethemes.moe/animeresource/
```
docs/jsonapi/reference/wiki/animeresource/show/index.md
-41
View File
@@ -1,41 +0,0 @@
---
title: Anime Resource Show
---
# Anime Resource Show Endpoint
The anime resource show endpoint returns an anime resource resource.
For example, the `/animeresource/bakemonogatari/1083` endpoint will return the anime resource resource for the association between the Bakemonogatari anime and the external resource of id 1083.
## URL
```sh
GET /animeresource/{anime:slug}/{resource:id}
```
## Authentication
None
## Parameters
None
## Response
```json
{
animeresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl https://api.animethemes.moe/animeresource/bakemonogatari/1083
```
docs/jsonapi/reference/wiki/animeresource/store/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Anime Resource Store
---
# Anime Resource Store Endpoint
The anime resource store endpoint creates a new anime resource and returns the new anime resource resource.
For example, the `/animeresource/bakemonogatari/1083` endpoint will create a new association between the Bakemonogatari anime and the external resource of id 1083.
## URL
```sh
POST /animeresource/{anime:slug}/{resource:id}
```
## Authentication
**Required Permission**: create anime, create external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :--: | :------: | :-------------- |
| as | No | string, max:192 |
## Response
```json
{
animeresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeresource/bakemonogatari/1083
```
docs/jsonapi/reference/wiki/animeresource/update/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Anime Resource Update
---
# Anime Resource Update Endpoint
The anime resource store endpoint updates an anime resource and returns the updated anime resource resource.
For example, the `/animeresource/bakemonogatari/1083?as=updated+label` endpoint will update the association between the Bakemonogatari anime and the external resource of id 1083.
## URL
```sh
PUT|PATCH /animeresource/{anime:slug}/{resource:id}
```
## Authentication
**Required Permission**: update anime, update external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :---------: | :------: | :-------------- |
| as | No | string, max:192 |
## Response
```json
{
animeresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/animeresource/
```
docs/jsonapi/reference/wiki/artistimage/destroy/index.md
-39
View File
@@ -1,39 +0,0 @@
---
title: Artist Image Destroy
---
# Artist Image Destroy Endpoint
The artist image destroy endpoint deletes an artist image and returns the deleted artist image resource.
For example, the `/artistimage/chiwa_saitou/6703` endpoint will delete the association between the Chiwa Saitou artist and the large cover image of id 6703.
## URL
```sh
DELETE /artistimage/{artist:slug}/{image:id}
```
## Authentication
**Required Permission**: delete artist, delete image
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
None
## Response
```json
{
message: "Image 'KXWxcUb0dF3Kb1SmWP2GRcd72Nv6a0OEjj33pDmP.png' has been detached from Artist 'Chiwa Saitou'.",
}
```
## Example
```bash
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistimage/chiwa_saitou/6703
```
docs/jsonapi/reference/wiki/artistimage/index.md
-27
View File
@@ -15,30 +15,3 @@ An artist image API resource represents the association between an artist and an
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
| depth | Int | Yes | No | Used to sort the artist images |
## Allowed Include Paths
* artist
* image
## Endpoints
**[Artist Image Destroy](/wiki/artistimage/destroy/)**
The artist image destroy endpoint deletes an artist image and returns the deleted artist image resource.
**[Artist Image Index](/wiki/artistimage/index/)**
The artist image index endpoint displays a listing of artist image resources.
**[Artist Image Show](/wiki/artistimage/show/)**
The artist image show endpoint returns an artist image resource.
**[Artist Image Store](/wiki/artistimage/store/)**
The artist image store endpoint creates a new artist image and returns the new artist image resource.
**[Artist Image Update](/wiki/artistimage/update/)**
The artist image update endpoint updates an artist image and returns the updated artist image resource.
docs/jsonapi/reference/wiki/artistimage/index/index.md
-79
View File
@@ -1,79 +0,0 @@
---
title: Artist Image Index
---
# Artist Image Index Endpoint
The artist image index endpoint returns a listing of artist image resources.
## URL
```sh
GET /artistimage/
```
## Authentication
None
## Parameters
| Name | Required | Description |
| :----------: | :------: | :----------------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for artist image resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of artist image resources to display |
| page[size] | No | The number of artist 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 |
| depth | Sort resources by orderable images |
## 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 |
| depth | Filter resources on depth level |
## Response
```json
{
artistimages: [
{
created_at: "created_at",
updated_at: "updated_at",
depth: depth
},
...
],
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
```bash
curl https://api.animethemes.moe/artistimage/
```
docs/jsonapi/reference/wiki/artistimage/show/index.md
-41
View File
@@ -1,41 +0,0 @@
---
title: Artist Image Show
---
# Artist Image Show Endpoint
The artist image show endpoint returns an artist image resource.
For example, the `/artistimage/chiwa_saitou/6703` endpoint will return the artist image resource for the association between the Chiwa Saitou artist and the large cover image of id 6703.
## URL
```sh
GET /artistimage/{artist:slug}/{image:id}
```
## Authentication
None
## Parameters
None
## Response
```json
{
artistimage: {
created_at: "created_at",
updated_at: "updated_at",
depth: depth
}
}
```
## Example
```bash
curl https://api.animethemes.moe/artistimage/chiwa_saitou/6703
```
docs/jsonapi/reference/wiki/artistimage/store/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Artist Image Store
---
# Artist Image Store Endpoint
The artist image store endpoint creates a new artist image and returns the new artist image resource.
For example, the `/artistimage/chiwa_saitou/6703` endpoint will create a new association between the Chiwa Saitou artist and the large cover image of id 6703.
## URL
```sh
POST /artistimage/{artist:slug}/{image:id}
```
## Authentication
**Required Permission**: create artist, create image
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :---: | :------: | :-------------- |
| depth | No | integer, min:1 |
## Response
```json
{
artistimage: {
created_at: "created_at",
updated_at: "updated_at",
depth: depth
}
}
```
## Example
```bash
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistimage/chiwa_saitou/6703
```
docs/jsonapi/reference/wiki/artistimage/update/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Artist Image Update
---
# Artist Image Update Endpoint
The artist image update endpoint updates an artist image and returns the updated artist image resource.
For example, the `/artistimage/claris/5?depth=2` endpoint will update the association between the claris and the image of id 5.
## URL
```sh
PUT|PATCH /artistimage/{artist:slug}/{image:id}
```
## Authentication
**Required Permission**: update artist, update image
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :---------: | :------: | :-------------- |
| depth | No | integer, min:1 |
## Response
```json
{
artistimage: {
created_at: "created_at",
updated_at: "updated_at",
depth: depth
}
}
```
## Example
```bash
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistimage/
```
docs/jsonapi/reference/wiki/artistresource/destroy/index.md
-39
View File
@@ -1,39 +0,0 @@
---
title: Artist Resource Destroy
---
# Artist Resource Destroy Endpoint
The artist resource destroy endpoint deletes an artist resource and returns the deleted artist resource resource.
For example, the `/artistresource/chiwa_saitou/3361` endpoint will delete the association between the Chiwa Saitou artist and the external resource of id 3361.
## URL
```sh
DELETE /artistresource/{artist:slug}/{resource:id}
```
## Authentication
**Required Permission**: delete artist, delete external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
None
## Response
```json
{
message: "Resource 'https://myanimelist.net/people/61' has been detached from Artist 'Chiwa Saitou'.",
}
```
## Example
```bash
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistresource/chiwa_saitou/3361
```
docs/jsonapi/reference/wiki/artistresource/index.md
-27
View File
@@ -15,30 +15,3 @@ An artist resource API resource represents the association between an artist and
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
| as | String | No | Yes | Used to distinguish resources that map to the same artist |
## Allowed Include Paths
* artist
* resource
## Endpoints
**[Artist Resource Destroy](/wiki/artistresource/destroy/)**
The artist resource destroy endpoint deletes an artist resource and returns the deleted artist resource resource.
**[Artist Resource Index](/wiki/artistresource/index/)**
The artist resource index endpoint displays a listing of artist resource resources.
**[Artist Resource Show](/wiki/artistresource/show/)**
The artist resource show endpoint returns an artist resource resource.
**[Artist Resource Store](/wiki/artistresource/store/)**
The artist resource store endpoint creates a new artist resource and returns the new artist resource resource.
**[Artist Resource Update](/wiki/artistresource/update/)**
The artist resource update endpoint updates an artist resource and returns the updated artist resource resource.
docs/jsonapi/reference/wiki/artistresource/index/index.md
-79
View File
@@ -1,79 +0,0 @@
---
title: Artist Resource Index
---
# Artist Resource Index Endpoint
The artist resource index endpoint returns a listing of artist resource resources.
## URL
```sh
GET /artistresource/
```
## Authentication
None
## Parameters
| Name | Required | Description |
| :----------: | :------: | :----------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for artist resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of artist resource resources to display |
| page[size] | No | The number of artist resource 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 |
| as | Sort resources on distinguishing label |
## Filters
| Name | Description |
| :--------: | :--------------------------------------------------------- |
| created_at | Filter resources on the resource creation date |
| updated_at | Filter resources on the resource last modified date |
| as | Filter resources on the resource distinguishing label |
| has | Filter resources on relations within allowed include paths |
## Response
```json
{
artistresources: [
{
created_at: "created_at",
updated_at: "updated_at",
as: "as"
},
...
],
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
```bash
curl https://api.animethemes.moe/artistresource/
```
docs/jsonapi/reference/wiki/artistresource/show/index.md
-41
View File
@@ -1,41 +0,0 @@
---
title: Artist Resource Show
---
# Artist Resource Show Endpoint
The artist resource show endpoint returns an artist resource resource.
For example, the `/artistresource/chiwa_saitou/3361` endpoint will return the artist resource resource for the association between the Chiwa Saitou artist and the external resource of id 3361.
## URL
```sh
GET /artistresource/{artist:slug}/{resource:id}
```
## Authentication
None
## Parameters
None
## Response
```json
{
artistresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl https://api.animethemes.moe/artistresource/chiwa_saitou/3361
```
docs/jsonapi/reference/wiki/artistresource/store/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Artist Resource Store
---
# Artist Resource Store Endpoint
The artist resource store endpoint creates a new artist resource and returns the new artist resource resource.
For example, the `/artistresource/chiwa_saitou/3361` endpoint will create a new association between the Chiwa Saitou artist and the external resource of id 3361.
## URL
```sh
POST /artistresource/{artist:slug}/{resource:id}
```
## Authentication
**Required Permission**: create artist, create external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :--: | :------: | :-------------- |
| as | No | string, max:192 |
## Response
```json
{
artistresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistresource/chiwa_saitou/3361
```
docs/jsonapi/reference/wiki/artistresource/update/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Artist Resource Update
---
# Artist Resource Update Endpoint
The artist resource store endpoint updates an artist resource and returns the updated artist resource resource.
For example, the `/artistresource/chiwa_saitou/3361?as=updated+label` endpoint will update the association between the Chiwa Saitou artist and the external resource of id 3361.
## URL
```sh
PUT|PATCH /artistresource/{artist:slug}/{resource:id}
```
## Authentication
**Required Permission**: update artist, update external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :---------: | :------: | :-------------- |
| as | No | string, max:192 |
## Response
```json
{
artistresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistresource/
```
docs/jsonapi/reference/wiki/songresource/destroy/index.md
-39
View File
@@ -1,39 +0,0 @@
---
title: Song Resource Destroy
---
# Song Resource Destroy Endpoint
The song resource destroy endpoint deletes an song resource and returns the deleted song resource resource.
For example, the `/songresource/10535/30212` endpoint will delete the association between the Mijuku DREAMER song and the external resource of id 30212.
## URL
```sh
DELETE /songresource/{song:id}/{resource:id}
```
## Authentication
**Required Permission**: delete song, delete external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
None
## Response
```json
{
message: "Resource 'https://open.spotify.com/track/6f9SU0JwNjVDjduReyFpAd?si=2719f3d5bd014f17' has been detached from Song 'Mijuku DREAMER'.",
}
```
## Example
```bash
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/songresource/10535/30212
```
docs/jsonapi/reference/wiki/songresource/index.md
-27
View File
@@ -15,30 +15,3 @@ An song resource API resource represents the association between an song and an
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
| as | String | No | Yes | Used to distinguish resources that map to the same song |
## Allowed Include Paths
* song
* resource
## Endpoints
**[Song Resource Destroy](/wiki/songresource/destroy/)**
The song resource destroy endpoint deletes an song resource and returns the deleted song resource resource.
**[Song Resource Index](/wiki/songresource/index/)**
The song resource index endpoint displays a listing of song resource resources.
**[Song Resource Show](/wiki/songresource/show/)**
The song resource show endpoint returns an song resource resource.
**[Song Resource Store](/wiki/songresource/store/)**
The song resource store endpoint creates a new song resource and returns the new song resource resource.
**[Song Resource Update](/wiki/songresource/update/)**
The song resource update endpoint updates an song resource and returns the updated song resource resource.
docs/jsonapi/reference/wiki/songresource/index/index.md
-79
View File
@@ -1,79 +0,0 @@
---
title: Song Resource Index
---
# Song Resource Index Endpoint
The song resource index endpoint returns a listing of song resource resources.
## URL
```sh
GET /songresource/
```
## Authentication
None
## Parameters
| Name | Required | Description |
| :----------: | :------: | :---------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for song resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of song resource resources to display |
| page[size] | No | The number of song resource 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 |
| as | Sort resources on distinguishing label |
## Filters
| Name | Description |
| :--------: | :--------------------------------------------------------- |
| created_at | Filter resources on the resource creation date |
| updated_at | Filter resources on the resource last modified date |
| as | Filter resources on the resource distinguishing label |
| has | Filter resources on relations within allowed include paths |
## Response
```json
{
songresources: [
{
created_at: "created_at",
updated_at: "updated_at",
as: "as"
},
...
],
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
```bash
curl https://api.animethemes.moe/songresource/
```
docs/jsonapi/reference/wiki/songresource/show/index.md
-41
View File
@@ -1,41 +0,0 @@
---
title: Song Resource Show
---
# Song Resource Show Endpoint
The song resource show endpoint returns an song resource resource.
For example, the `/songresource/10535/30212` endpoint will return the song resource resource for the association between the Mijuku DREAMER song and the external resource of id 30212.
## URL
```sh
GET /songresource/{song:id}/{resource:id}
```
## Authentication
None
## Parameters
None
## Response
```json
{
songresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl https://api.animethemes.moe/songresource/10535/30212
```
docs/jsonapi/reference/wiki/songresource/store/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Song Resource Store
---
# Song Resource Store Endpoint
The song resource store endpoint creates a new song resource and returns the new song resource resource.
For example, the `/songresource/10535/30212` endpoint will create a new association between the Mijuku DREAMER song and the external resource of id 30212.
## URL
```sh
POST /songresource/{song:id}/{resource:id}
```
## Authentication
**Required Permission**: create song, create external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :--: | :------: | :-------------- |
| as | No | string, max:192 |
## Response
```json
{
songresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/songresource/10535/30212
```
docs/jsonapi/reference/wiki/songresource/update/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Song Resource Update
---
# Song Resource Update Endpoint
The song resource store endpoint updates an song resource and returns the updated song resource resource.
For example, the `/songresource/10535/30212?as=updated+label` endpoint will update the association between the Mijuku DREAMER song and the external resource of id 30212.
## URL
```sh
PUT|PATCH /songresource/{song:id}/{resource:id}
```
## Authentication
**Required Permission**: update song, update external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :---------: | :------: | :-------------- |
| as | No | string, max:192 |
## Response
```json
{
songresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/songresource/
```
docs/jsonapi/reference/wiki/studioimage/destroy/index.md
-39
View File
@@ -1,39 +0,0 @@
---
title: Studio Image Destroy
---
# Studio Image Destroy Endpoint
The studio image destroy endpoint deletes a studio image and returns the deleted studio image resource.
For example, the `/studioimage/shaft/9292` endpoint will delete the association between the Shaft studio and the large cover image of id 9292.
## URL
```sh
DELETE /studioimage/{studio:slug}/{image:id}
```
## Authentication
**Required Permission**: delete studio, delete image
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
None
## Response
```json
{
message: "Image 'MAJjc1O52inaVlaCtoC2VSZkqjRFDdGW9XN7pmz3.png' has been detached from Studio 'Shaft'.",
}
```
## Example
```bash
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/studioimage/shaft/9292
```
docs/jsonapi/reference/wiki/studioimage/index.md
-23
View File
@@ -14,26 +14,3 @@ A studio image API resource represents the association between a studio and an i
| :--------: | :-----: | :------: | :-----: | :------------------------------------------- |
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
## Allowed Include Paths
* studio
* image
## Endpoints
**[Studio Image Destroy](/wiki/studioimage/destroy/)**
The studio image destroy endpoint deletes a studio image and returns the deleted studio image resource.
**[Studio Image Index](/wiki/studioimage/index/)**
The studio image index endpoint displays a listing of studio image resources.
**[Studio Image Show](/wiki/studioimage/show/)**
The studio image show endpoint returns a studio image resource.
**[Studio Image Store](/wiki/studioimage/store/)**
The studio image store endpoint creates a new studio image and returns the new studio image resource.
docs/jsonapi/reference/wiki/studioimage/index/index.md
-76
View File
@@ -1,76 +0,0 @@
---
title: Studio Image Index
---
# Studio Image Index Endpoint
The studio image index endpoint returns a listing of studio image resources.
## URL
```sh
GET /studioimage/
```
## Authentication
None
## Parameters
| Name | Required | Description |
| :----------: | :------: | :----------------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for studio image resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of studio image resources to display |
| page[size] | No | The number of studio 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
{
studioimages: [
{
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
```bash
curl https://api.animethemes.moe/studioimage/
```
docs/jsonapi/reference/wiki/studioimage/show/index.md
-40
View File
@@ -1,40 +0,0 @@
---
title: Studio Image Show
---
# Studio Image Show Endpoint
The studio image show endpoint returns a studio image resource.
For example, the `/studioimage/shaft/9292` endpoint will return the studio image resource for the association between the Shaft studio and the large cover image of id 9292.
## URL
```sh
GET /studioimage/{studio:slug}/{image:id}
```
## Authentication
None
## Parameters
None
## Response
```json
{
studioimage: {
created_at: "created_at",
updated_at: "updated_at"
}
}
```
## Example
```bash
curl https://api.animethemes.moe/studioimage/shaft/9292
```
docs/jsonapi/reference/wiki/studioimage/store/index.md
-42
View File
@@ -1,42 +0,0 @@
---
title: Studio Image Store
---
# Studio Image Store Endpoint
The studio image store endpoint creates a new studio image and returns the new studio image resource.
For example, the `/studioimage/shaft/9292` endpoint will create a new association between the Shaft studio and the large cover image of id 9292.
## URL
```sh
POST /studioimage/{studio:slug}/{image:id}
```
## Authentication
**Required Permission**: create studio, create image
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
None
## Response
```json
{
studioimage: {
created_at: "created_at",
updated_at: "updated_at"
}
}
```
## Example
```bash
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/studioimage/shaft/9292
```
docs/jsonapi/reference/wiki/studioresource/destroy/index.md
-39
View File
@@ -1,39 +0,0 @@
---
title: Studio Resource Destroy
---
# Studio Resource Destroy Endpoint
The studio resource destroy endpoint deletes a studio resource and returns the deleted studio resource resource.
For example, the `/studioresource/shaft/14891` endpoint will delete the association between the Shaft studio and the external resource of id 14891.
## URL
```sh
DELETE /studioresource/{studio:slug}/{resource:id}
```
## Authentication
**Required Permission**: delete studio, delete external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
None
## Response
```json
{
message: "Resource 'https://myanimelist.net/anime/producer/44' has been detached from Studio 'Shaft'.",
}
```
## Example
```bash
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/studioresource/shaft/14891
```
docs/jsonapi/reference/wiki/studioresource/index.md
-27
View File
@@ -15,30 +15,3 @@ A studio resource API resource represents the association between a studio and a
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
| as | String | No | Yes | Used to distinguish resources that map to the same studio |
## Allowed Include Paths
* studio
* resource
## Endpoints
**[Studio Resource Destroy](/wiki/studioresource/destroy/)**
The studio resource destroy endpoint deletes a studio resource and returns the deleted studio resource resource.
**[Studio Resource Index](/wiki/studioresource/index/)**
The studio resource index endpoint displays a listing of studio resource resources.
**[Studio Resource Show](/wiki/studioresource/show/)**
The studio resource show endpoint returns a studio resource resource.
**[Studio Resource Store](/wiki/studioresource/store/)**
The studio resource store endpoint creates a new studio resource and returns the new studio resource resource.
**[Studio Resource Update](/wiki/studioresource/update/)**
The studio resource update endpoint updates a studio resource and returns the updated studio resource resource.
docs/jsonapi/reference/wiki/studioresource/index/index.md
-79
View File
@@ -1,79 +0,0 @@
---
title: Studio Resource Index
---
# Studio Resource Index Endpoint
The studio resource index endpoint returns a listing of studio resource resources.
## URL
```sh
GET /studioresource/
```
## Authentication
None
## Parameters
| Name | Required | Description |
| :----------: | :------: | :----------------------------------------------------------------------------- |
| fields | No | Sparse fieldsets for resource types |
| filter | No | Filters for studio resources & constraining the inclusion of related resources |
| include | No | Inclusion of related resources |
| page[number] | No | The page of studio resource resources to display |
| page[size] | No | The number of studio resource 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 |
| as | Sort resources on distinguishing label |
## Filters
| Name | Description |
| :--------: | :--------------------------------------------------------- |
| created_at | Filter resources on the resource creation date |
| updated_at | Filter resources on the resource last modified date |
| as | Filter resources on the resource distinguishing label |
| has | Filter resources on relations within allowed include paths |
## Response
```json
{
studioresources: [
{
created_at: "created_at",
updated_at: "updated_at",
as: "as"
},
...
],
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
```bash
curl https://api.animethemes.moe/studioresource/
```
docs/jsonapi/reference/wiki/studioresource/show/index.md
-41
View File
@@ -1,41 +0,0 @@
---
title: Studio Resource Show
---
# Studio Resource Show Endpoint
The studio resource show endpoint returns a studio resource resource.
For example, the `/studioresource/shaft/14891` endpoint will return the studio resource resource for the association between the Shaft studio and the external resource of id 14891.
## URL
```sh
GET /studioresource/{studio:slug}/{resource:id}
```
## Authentication
None
## Parameters
None
## Response
```json
{
studioresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl https://api.animethemes.moe/studioresource/shaft/14891
```
docs/jsonapi/reference/wiki/studioresource/store/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Studio Resource Store
---
# Studio Resource Store Endpoint
The studio resource store endpoint creates a new studio resource and returns the new studio resource resource.
For example, the `/studioresource/shaft/14891` endpoint will create a new association between the Shaft studio and the external resource of id 14891.
## URL
```sh
POST /studioresource/{studio:slug}/{resource:id}
```
## Authentication
**Required Permission**: create studio, create external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :--: | :------: | :-------------- |
| as | No | string, max:192 |
## Response
```json
{
studioresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/studioresource/shaft/14891
```
docs/jsonapi/reference/wiki/studioresource/update/index.md
-45
View File
@@ -1,45 +0,0 @@
---
title: Studio Resource Update
---
# Studio Resource Update Endpoint
The studio resource store endpoint updates a studio resource and returns the updated studio resource resource.
For example, the `/studioresource/shaft/14891?as=updated+label` endpoint will update the association between the Shaft studio and the external resource of id 14891.
## URL
```sh
PUT|PATCH /studioresource/{studio:slug}/{resource:id}
```
## Authentication
**Required Permission**: update studio, update external resource
**Roles with Permission**: Wiki Editor, Encoder, Admin
## Parameters
| Name | Required | Rules |
| :---------: | :------: | :-------------- |
| as | No | string, max:192 |
## Response
```json
{
studioresource: {
created_at: "created_at",
updated_at: "updated_at",
as: "as"
}
}
```
## Example
```bash
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/studioresource/
```