mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-07-11 01:34:06 +02:00
feat: added group resource and encoder role (#100)
This commit is contained in:
Kyrch
@@ -105,6 +105,7 @@ export default {
|
||||
{ text: 'Artist Resource', link: '/wiki/artistresource/' },
|
||||
{ text: 'Artist Song', link: '/wiki/artistsong/' },
|
||||
{ text: 'Audio', link: '/wiki/audio/' },
|
||||
{ text: 'Group', link: '/wiki/group/' },
|
||||
{ text: 'Image', link: '/wiki/image/' },
|
||||
{ text: 'Resource', link: '/wiki/resource/' },
|
||||
{ text: 'Series', link: '/wiki/series/' },
|
||||
@@ -469,6 +470,20 @@ export default {
|
||||
{ text: 'Update', link: '/wiki/audio/update/' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Group',
|
||||
collapsed: true,
|
||||
items: [
|
||||
{ text: 'Resource', link: '/wiki/group/' },
|
||||
{ text: 'Destroy', link: '/wiki/group/destroy/' },
|
||||
{ text: 'Force Delete', link: '/wiki/group/forceDelete/' },
|
||||
{ text: 'Index', link: '/wiki/group/index/' },
|
||||
{ text: 'Restore', link: '/wiki/group/restore/' },
|
||||
{ text: 'Show', link: '/wiki/group/show/' },
|
||||
{ text: 'Store', link: '/wiki/group/store/' },
|
||||
{ text: 'Update', link: '/wiki/group/update/' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Image',
|
||||
collapsed: true,
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /page/{slug}
|
||||
|
||||
**Required Permission**: delete page
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Page must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/page/{slug}
|
||||
|
||||
**Required Permission**: restore page
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Page must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /page
|
||||
|
||||
**Required Permission**: create page
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /page/{slug}
|
||||
|
||||
**Required Permission**: update page
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Page must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /anime/{slug}
|
||||
|
||||
**Required Permission**: delete anime
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime must not be soft deleted
|
||||
|
||||
|
||||
@@ -33,6 +33,7 @@ For example, Bakemonogatari is an anime production with five opening sequences a
|
||||
* animethemes.animethemeentries.videos
|
||||
* animethemes.animethemeentries.videos.audio
|
||||
* animethemes.animethemeentries.videos.videoscript
|
||||
* animethemes.group
|
||||
* animethemes.song
|
||||
* animethemes.song.artists
|
||||
* images
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/anime/{slug}
|
||||
|
||||
**Required Permission**: restore anime
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /anime
|
||||
|
||||
**Required Permission**: create anime
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /anime/{slug}
|
||||
|
||||
**Required Permission**: update anime
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /animeimage/{anime:slug}/{image:id}
|
||||
|
||||
**Required Permission**: delete anime, delete image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /animeimage/{anime:slug}/{image:id}
|
||||
|
||||
**Required Permission**: create anime, create image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /animeresource/{anime:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: delete anime, delete external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /animeresource/{anime:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: create anime, create external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /animeresource/{anime:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: update anime, update external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /animeseries/{anime:slug}/{series:slug}
|
||||
|
||||
**Required Permission**: delete anime, delete series
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /animeseries/{anime:slug}/{series:slug}
|
||||
|
||||
**Required Permission**: create anime, create series
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /animestudio/{anime:slug}/{studio:slug}
|
||||
|
||||
**Required Permission**: delete anime, delete studio
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /animestudio/{anime:slug}/{studio:slug}
|
||||
|
||||
**Required Permission**: create anime, create studio
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /animesynonym/{id}
|
||||
|
||||
**Required Permission**: delete anime synonym
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime synonym must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/animesynonym/{id}
|
||||
|
||||
**Required Permission**: restore anime synonym
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Synonym must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /animesynonym
|
||||
|
||||
**Required Permission**: create anime synonym
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /animesynonym/{id}
|
||||
|
||||
**Required Permission**: update anime synonym
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime synonym must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /animetheme/{id}
|
||||
|
||||
**Required Permission**: delete anime theme
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime theme must not be soft deleted
|
||||
|
||||
@@ -34,7 +34,6 @@ None
|
||||
id: id,
|
||||
type: "type",
|
||||
sequence: sequence,
|
||||
group: "group",
|
||||
slug: "slug",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
|
||||
@@ -17,7 +17,6 @@ For example, the anime Bakemonogatari has five OP anime themes and one ED anime
|
||||
| id | Integer | No | Yes | The primary key of the resource |
|
||||
| type | Enum | Yes | Yes | The type of the sequence [OP, ED] |
|
||||
| sequence | Integer | Yes | Yes | The numeric ordering of the theme |
|
||||
| group | String | Yes | Yes | Used to distinguish sequence belongs to dubs, rebroadcasts, etc. |
|
||||
| slug | String | No | Yes | The URL slug & route key of the resource |
|
||||
| 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 |
|
||||
@@ -29,6 +28,7 @@ For example, the anime Bakemonogatari has five OP anime themes and one ED anime
|
||||
* anime.images
|
||||
* animethemeentries
|
||||
* animethemeentries.videos
|
||||
* group
|
||||
* song
|
||||
* song.artists
|
||||
|
||||
|
||||
@@ -35,7 +35,6 @@ None
|
||||
| id | Sort resources on the primary key |
|
||||
| type | Sort resources on the type of the sequence |
|
||||
| sequence | Sort resources on the numeric ordering |
|
||||
| group | Sort resources on the distinguishing of themes to dubs, etc |
|
||||
| slug | Sort resources on the URL slug of the theme |
|
||||
| created_at | Sort resources on the resource creation date |
|
||||
| updated_at | Sort resources on the resource last modified date |
|
||||
@@ -58,7 +57,6 @@ None
|
||||
| id | Filter resources on the primary key |
|
||||
| type | Filter resources on the type of the sequence |
|
||||
| sequence | Filter resources on the numeric ordering |
|
||||
| group | Filter resources on the distinguishing of themes to dubs, etc |
|
||||
| slug | Filter resources on the URL slug of the theme |
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
@@ -75,7 +73,6 @@ None
|
||||
id: id,
|
||||
type: "type",
|
||||
sequence: sequence,
|
||||
group: "group",
|
||||
slug: "slug",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/animetheme/{id}
|
||||
|
||||
**Required Permission**: restore anime theme
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Theme must be soft deleted
|
||||
|
||||
@@ -34,7 +34,6 @@ None
|
||||
id: id,
|
||||
type: "type",
|
||||
sequence: sequence,
|
||||
group: "group",
|
||||
slug: "slug",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
|
||||
@@ -35,7 +35,6 @@ None
|
||||
id: id,
|
||||
type: "type",
|
||||
sequence: sequence,
|
||||
group: "group",
|
||||
slug: "slug",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /animetheme
|
||||
|
||||
**Required Permission**: create anime theme
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
@@ -27,7 +27,6 @@ POST /animetheme
|
||||
| anime_id | Yes | integer, Anime ID exists |
|
||||
| type | Yes | EnumValue [OP, ED] |
|
||||
| sequence | No | integer, min:0 |
|
||||
| group | No | string, max:192 |
|
||||
| slug | Yes | string, max:192, alpha_dash |
|
||||
| song_id | No | integer, Song ID exists |
|
||||
|
||||
@@ -39,7 +38,6 @@ POST /animetheme
|
||||
id: id,
|
||||
type: "type",
|
||||
sequence: sequence,
|
||||
group: "group",
|
||||
slug: "slug",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /animetheme/{id}
|
||||
|
||||
**Required Permission**: update anime theme
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime theme must not be soft deleted
|
||||
|
||||
@@ -29,7 +29,6 @@ PUT|PATCH /animetheme/{id}
|
||||
| anime_id | No | integer, Anime ID exists |
|
||||
| type | No | EnumValue [OP, ED] |
|
||||
| sequence | No | integer, min:0 |
|
||||
| group | No | string, max:192 |
|
||||
| slug | No | string, max:192, alpha_dash |
|
||||
| song_id | No | integer, Song ID exists |
|
||||
|
||||
@@ -41,7 +40,6 @@ PUT|PATCH /animetheme/{id}
|
||||
id: id,
|
||||
type: "type",
|
||||
sequence: sequence,
|
||||
group: "group",
|
||||
slug: "slug",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /animethemeentry/{id}
|
||||
|
||||
**Required Permission**: delete anime theme entry
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime theme entry must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/animethemeentry/{id}
|
||||
|
||||
**Required Permission**: restore anime theme entry
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Entry must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /animethemeentry
|
||||
|
||||
**Required Permission**: create anime theme entry
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /animethemeentry/{id}
|
||||
|
||||
**Required Permission**: update anime theme entry
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Anime theme entry must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /animethemeentryvideo/{animethemeentry:id}/{video:slug}
|
||||
|
||||
**Required Permission**: delete anime theme entry, delete video
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /animethemeentryvideo/{animethemeentry:id}/{video:slug}
|
||||
|
||||
**Required Permission**: create anime theme entry, create video
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /artist/{slug}
|
||||
|
||||
**Required Permission**: delete artist
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Artist must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/artist/{slug}
|
||||
|
||||
**Required Permission**: restore artist
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Artist must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /artist
|
||||
|
||||
**Required Permission**: create artist
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /artist/{slug}
|
||||
|
||||
**Required Permission**: update artist
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Artist must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /artistimage/{artist:slug}/{image:id}
|
||||
|
||||
**Required Permission**: delete artist, delete image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /artistimage/{artist:slug}/{image:id}
|
||||
|
||||
**Required Permission**: create artist, create image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /artistmember/{artist:slug}/{artist:slug}
|
||||
|
||||
**Required Permission**: delete artist
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /artistmember/{artist:slug}/{artist:slug}
|
||||
|
||||
**Required Permission**: create artist
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /artistmember/{artist:slug}/{artist:slug}
|
||||
|
||||
**Required Permission**: update artist
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /artistresource/{artist:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: delete artist, delete external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /artistresource/{artist:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: create artist, create external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /artistresource/{artist:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: update artist, update external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /artistsong/{artist:slug}/{song:id}
|
||||
|
||||
**Required Permission**: delete artist, delete song
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /artistsong/{artist:slug}/{song:id}
|
||||
|
||||
**Required Permission**: create artist, create song
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /artistsong/{artist:slug}/{song:id}
|
||||
|
||||
**Required Permission**: update artist, update song
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /audio/{basename}
|
||||
|
||||
**Required Permission**: delete audio
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
**Other Requirements**: Audio must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/audio/{basename}
|
||||
|
||||
**Required Permission**: restore audio
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
**Other Requirements**: Audio must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /audio
|
||||
|
||||
**Required Permission**: create audio
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /audio/{basename}
|
||||
|
||||
**Required Permission**: update audio
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Audio must not be soft deleted
|
||||
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: Group Destroy
|
||||
---
|
||||
|
||||
# Group Destroy Endpoint
|
||||
|
||||
The group destroy endpoint soft deletes a group and returns the deleted group resource.
|
||||
|
||||
For example, the `/group/1` endpoint will soft delete the "staple stable" group and return the deleted "English Version" resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /group/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: delete group
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Group must not be soft deleted
|
||||
|
||||
## Parameters
|
||||
|
||||
None
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
group: {
|
||||
id: id,
|
||||
name: "name",
|
||||
slug: "slug",
|
||||
video_filename: "video_filename",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
deleted_at: "deleted_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/group/1
|
||||
```
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Group Force Delete
|
||||
---
|
||||
|
||||
# Group Force Delete Endpoint
|
||||
|
||||
The group force delete endpoint hard deletes a group and returns a confirmation message.
|
||||
|
||||
For example, the `/forceDelete/group/1` endpoint will hard delete the "English Version" group and return a confirmation message.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
DELETE /forceDelete/group/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: force delete group
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
None
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
message: "The Group 'English Version' was deleted.",
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/group/3373
|
||||
```
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Group
|
||||
---
|
||||
|
||||
# Group
|
||||
|
||||
---
|
||||
|
||||
A group API resource represents the group that accompanies an AnimeTheme.
|
||||
|
||||
For example, English Version is the group for english dubbed AnimeTheme.
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Nullable | Default | Description |
|
||||
| :-------------------: | :-----: | :------: | :-----: | :------------------------------------------- |
|
||||
| id | Integer | No | Yes | The primary key of the resource |
|
||||
| name | String | No | No | The name of the group |
|
||||
| slug | String | No | No | The slug of the group |
|
||||
| video_filename | String | Yes | Yes | The filename used to the video related |
|
||||
| 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 |
|
||||
| deleted_at | Date | Yes | No | The date that the resource was deleted |
|
||||
|
||||
## Allowed Include Paths
|
||||
|
||||
* animethemes
|
||||
* animethemes.anime
|
||||
* animethemes.animethemeentries.videos
|
||||
|
||||
## Endpoints
|
||||
|
||||
**[Group Destroy](/wiki/group/destroy/)**
|
||||
|
||||
The group destroy endpoint soft deletes a group and returns the deleted group resource.
|
||||
|
||||
**[Group Force Delete](/wiki/group/forceDelete/)**
|
||||
|
||||
The group force delete endpoint hard deletes a group and returns a confirmation message.
|
||||
|
||||
**[Group Index](/wiki/group/index/)**
|
||||
|
||||
The group index endpoint displays a listing of group resources.
|
||||
|
||||
**[Group Restore](/wiki/group/restore/)**
|
||||
|
||||
The group restore endpoint restores a soft deleted group and returns the restored group resource.
|
||||
|
||||
**[Group Show](/wiki/group/show/)**
|
||||
|
||||
The group show endpoint returns a group resource.
|
||||
|
||||
**[Group Store](/wiki/group/store/)**
|
||||
|
||||
The group store endpoint creates a new group and returns the new group resource.
|
||||
|
||||
**[Group Update](/wiki/group/update/)**
|
||||
|
||||
The group update endpoint updates a group and returns the updated group resource.
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: Group Index
|
||||
---
|
||||
|
||||
# Group Index Endpoint
|
||||
|
||||
The group index endpoint returns a listing of group resources.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /group/
|
||||
```
|
||||
|
||||
## 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 resources to display |
|
||||
| page[size] | No | The number of anime resources to display for the current page |
|
||||
| q | No | The query to search for matching anime resources |
|
||||
| sort | No | The list of fields to sort the resources |
|
||||
|
||||
## Allowed Sort Fields
|
||||
|
||||
| Name | Description |
|
||||
| :---------------: | :------------------------------------------------------------------ |
|
||||
| id | Sort resources on the primary key |
|
||||
| name | Sort resources on the title of the group |
|
||||
| slug | Sort resources on the slug of the group |
|
||||
| video_filename | Sort resources on the video_filename of the group |
|
||||
| created_at | Sort resources on the resource creation date |
|
||||
| updated_at | Sort resources on the resource last modified date |
|
||||
| deleted_at | Sort resources on the resource deletion date |
|
||||
| random | Sort resources randomly. Ignored if other sort fields are provided. |
|
||||
|
||||
## Filters
|
||||
|
||||
| Name | Description |
|
||||
| :---------------: | :----------------------------------------------------------------- |
|
||||
| id | Filter resources on the primary key |
|
||||
| title | Filter resources on the title of the group |
|
||||
| slug | Filter resources on the slug of the group |
|
||||
| video_filename | Filter resources on the video_filename of the group |
|
||||
| created_at | Filter resources on the resource creation date |
|
||||
| updated_at | Filter resources on the resource last modified date |
|
||||
| deleted_at | Filter resources on the resource deletion date |
|
||||
| trashed | Filter resources on trashed (deleted) status [With, Without, Only] |
|
||||
| has | Filter resources on relations within allowed include paths |
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
groups: [
|
||||
{
|
||||
id: id,
|
||||
name: "name",
|
||||
slug: "slug",
|
||||
video_filename: "video_filename",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
deleted_at: "deleted_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/group/
|
||||
```
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: Group Restore
|
||||
---
|
||||
|
||||
# Group Restore Endpoint
|
||||
|
||||
The group restore endpoint restores a soft deleted group and returns the restored group resource.
|
||||
|
||||
For example, the `/restore/group/1` endpoint will restore the soft deleted "English Version" group and return the restored "English Version" resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PATCH /restore/group/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: restore group
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Group must be soft deleted
|
||||
|
||||
## Parameters
|
||||
|
||||
None
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
group: {
|
||||
id: id,
|
||||
name: "name",
|
||||
slug: "slug",
|
||||
video_filename: "video_filename",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
deleted_at: "deleted_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/restore/group/1
|
||||
```
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Group Show
|
||||
---
|
||||
|
||||
# Group Show Endpoint
|
||||
|
||||
The group show endpoint returns a group resource.
|
||||
|
||||
For example, the `/group/1` endpoint will return the group resource for the English Version group.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
GET /group/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
None
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Required | Description |
|
||||
| :-----: | :------: | :------------------------------------------------------ |
|
||||
| fields | No | Sparse fieldsets for resource types |
|
||||
| filter | No | Filters to constrain the inclusion of related resources |
|
||||
| include | No | Inclusion of related resources |
|
||||
| sort | No | Sort related resources |
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
group: {
|
||||
id: id,
|
||||
name: "name",
|
||||
slug: "slug",
|
||||
video_filename: "video_filename",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
deleted_at: "deleted_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl https://api.animethemes.moe/group/1
|
||||
```
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
title: Group Store
|
||||
---
|
||||
|
||||
# Group Store Endpoint
|
||||
|
||||
The group store endpoint creates a new group and returns the new group resource.
|
||||
|
||||
For example, the `/group?name=English+Version` endpoint will create a new "English Version" group and return the new "English Version" resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
POST /group
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: create group
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Required | Rules |
|
||||
| :---------------: | :------: | :---------------------------------- |
|
||||
| name | Yes | string, max:192 |
|
||||
| slug | Yes | string, max:192, alpha_dash |
|
||||
| video_filename | No | string, max:192 |
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
group: {
|
||||
id: id,
|
||||
name: "name",
|
||||
slug: "slug",
|
||||
video_filename: "video_filename",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
deleted_at: "deleted_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/group/
|
||||
```
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Group Update
|
||||
---
|
||||
|
||||
# Group Update Endpoint
|
||||
|
||||
The group update endpoint updates a group and returns the updated group resource.
|
||||
|
||||
For example, the `/group/1?name=English+Version` endpoint will update the "English+Version" group title attribute and return the updated "English+Version" resource.
|
||||
|
||||
## URL
|
||||
|
||||
```sh
|
||||
PUT|PATCH /group/{id}
|
||||
```
|
||||
|
||||
## Authentication
|
||||
|
||||
**Required Permission**: update group
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Group must not be soft deleted
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Required | Rules |
|
||||
| :---------------: | :------: | :---------------------------------- |
|
||||
| name | Yes | string, max:192 |
|
||||
| slug | Yes | string, max:192, alpha_dash |
|
||||
| video_filename | No | string, max:192 |
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
{
|
||||
group: {
|
||||
id: id,
|
||||
name: "name",
|
||||
slug: "slug",
|
||||
video_filename: "video_filename",
|
||||
created_at: "created_at",
|
||||
updated_at: "updated_at",
|
||||
deleted_at: "deleted_at"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```bash
|
||||
curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/group/1
|
||||
```
|
||||
@@ -18,7 +18,7 @@ DELETE /image/{id}
|
||||
|
||||
**Required Permission**: delete image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Image must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/image/{id}
|
||||
|
||||
**Required Permission**: restore image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Image must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /image
|
||||
|
||||
**Required Permission**: create image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /image/{id}
|
||||
|
||||
**Required Permission**: update image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Image must not be soft deleted
|
||||
|
||||
|
||||
@@ -70,6 +70,10 @@ An artist song API resource represents the association between an artist and a s
|
||||
|
||||
An audio API resource represents the audio track of a video.
|
||||
|
||||
**[Group](/wiki/group/)**
|
||||
|
||||
A group API resource represents the group that accompanies an AnimeTheme.
|
||||
|
||||
**[Image](/wiki/image/)**
|
||||
|
||||
An image API resource represents a visual component for another resource such as an anime or artist.
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /resource/{id}
|
||||
|
||||
**Required Permission**: delete external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Resource must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/resource/{id}
|
||||
|
||||
**Required Permission**: restore external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: External resource must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /resource
|
||||
|
||||
**Required Permission**: create external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /resource/{id}
|
||||
|
||||
**Required Permission**: update external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Resource must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /series/{slug}
|
||||
|
||||
**Required Permission**: delete series
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Series must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/series/{slug}
|
||||
|
||||
**Required Permission**: restore series
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Series must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /series
|
||||
|
||||
**Required Permission**: create series
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /series/{slug}
|
||||
|
||||
**Required Permission**: update series
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Series must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /song/{id}
|
||||
|
||||
**Required Permission**: delete song
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Song must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/song/{id}
|
||||
|
||||
**Required Permission**: restore song
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Song must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /song
|
||||
|
||||
**Required Permission**: create song
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ title: Song Update
|
||||
|
||||
The song update endpoint updates a song and returns the updated song 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.
|
||||
For example, the `/song/3373?title=staple+stable` endpoint will update the "staple stable" song title attribute and return the updated "staple stable" resource.
|
||||
|
||||
## URL
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /song/{id}
|
||||
|
||||
**Required Permission**: update song
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Song must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /songresource/{song:id}/{resource:id}
|
||||
|
||||
**Required Permission**: delete song, delete external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /songresource/{song:id}/{resource:id}
|
||||
|
||||
**Required Permission**: create song, create external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /songresource/{song:id}/{resource:id}
|
||||
|
||||
**Required Permission**: update song, update external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /studio/{slug}
|
||||
|
||||
**Required Permission**: delete studio
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Studio must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/studio/{slug}
|
||||
|
||||
**Required Permission**: restore studio
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Studio must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /studio
|
||||
|
||||
**Required Permission**: create studio
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /studio/{slug}
|
||||
|
||||
**Required Permission**: update studio
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Studio must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /studioimage/{studio:slug}/{image:id}
|
||||
|
||||
**Required Permission**: delete studio, delete image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /studioimage/{studio:slug}/{image:id}
|
||||
|
||||
**Required Permission**: create studio, create image
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /studioresource/{studio:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: delete studio, delete external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /studioresource/{studio:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: create studio, create external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /studioresource/{studio:slug}/{resource:id}
|
||||
|
||||
**Required Permission**: update studio, update external resource
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /video/{basename}
|
||||
|
||||
**Required Permission**: delete video
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
**Other Requirements**: Video must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/video/{basename}
|
||||
|
||||
**Required Permission**: restore video
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
**Other Requirements**: Video must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /video
|
||||
|
||||
**Required Permission**: create video
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /video/{basename}
|
||||
|
||||
**Required Permission**: update video
|
||||
|
||||
**Roles with Permission**: Wiki Editor, Admin
|
||||
**Roles with Permission**: Wiki Editor, Encoder, Admin
|
||||
|
||||
**Other Requirements**: Video must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ DELETE /videoscript/{id}
|
||||
|
||||
**Required Permission**: delete video script
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
**Other Requirements**: Video script must not be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PATCH /restore/videoscript/{id}
|
||||
|
||||
**Required Permission**: restore video script
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
**Other Requirements**: Video script must be soft deleted
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ POST /videoscript
|
||||
|
||||
**Required Permission**: create video script
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
## Parameters
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ PUT|PATCH /videoscript/{id}
|
||||
|
||||
**Required Permission**: update video script
|
||||
|
||||
**Roles with Permission**: Admin
|
||||
**Roles with Permission**: Encoder, Admin
|
||||
|
||||
**Other Requirements**: Video script must not be soft deleted
|
||||
|
||||
|
||||
Reference in New Issue
Block a user