From fa9fda2500e29d244c13f863ec5d8ce79318de1b Mon Sep 17 00:00:00 2001 From: Kyrch Date: Mon, 29 Apr 2024 00:09:33 -0300 Subject: [PATCH] feat: added group resource and encoder role (#100) --- docs/.vitepress/config.js | 15 +++ docs/document/page/destroy/index.md | 2 +- docs/document/page/restore/index.md | 2 +- docs/document/page/store/index.md | 2 +- docs/document/page/update/index.md | 2 +- docs/wiki/anime/destroy/index.md | 2 +- docs/wiki/anime/index.md | 1 + docs/wiki/anime/restore/index.md | 2 +- docs/wiki/anime/store/index.md | 2 +- docs/wiki/anime/update/index.md | 2 +- docs/wiki/animeimage/destroy/index.md | 2 +- docs/wiki/animeimage/store/index.md | 2 +- docs/wiki/animeresource/destroy/index.md | 2 +- docs/wiki/animeresource/store/index.md | 2 +- docs/wiki/animeresource/update/index.md | 2 +- docs/wiki/animeseries/destroy/index.md | 2 +- docs/wiki/animeseries/store/index.md | 2 +- docs/wiki/animestudio/destroy/index.md | 2 +- docs/wiki/animestudio/store/index.md | 2 +- docs/wiki/animesynonym/destroy/index.md | 2 +- docs/wiki/animesynonym/restore/index.md | 2 +- docs/wiki/animesynonym/store/index.md | 2 +- docs/wiki/animesynonym/update/index.md | 2 +- docs/wiki/animetheme/destroy/index.md | 3 +- docs/wiki/animetheme/index.md | 2 +- docs/wiki/animetheme/index/index.md | 3 - docs/wiki/animetheme/restore/index.md | 3 +- docs/wiki/animetheme/show/index.md | 1 - docs/wiki/animetheme/store/index.md | 4 +- docs/wiki/animetheme/update/index.md | 4 +- docs/wiki/animethemeentry/destroy/index.md | 2 +- docs/wiki/animethemeentry/restore/index.md | 2 +- docs/wiki/animethemeentry/store/index.md | 2 +- docs/wiki/animethemeentry/update/index.md | 2 +- .../animethemeentryvideo/destroy/index.md | 2 +- docs/wiki/animethemeentryvideo/store/index.md | 2 +- docs/wiki/artist/destroy/index.md | 2 +- docs/wiki/artist/restore/index.md | 2 +- docs/wiki/artist/store/index.md | 2 +- docs/wiki/artist/update/index.md | 2 +- docs/wiki/artistimage/destroy/index.md | 2 +- docs/wiki/artistimage/store/index.md | 2 +- docs/wiki/artistmember/destroy/index.md | 2 +- docs/wiki/artistmember/store/index.md | 2 +- docs/wiki/artistmember/update/index.md | 2 +- docs/wiki/artistresource/destroy/index.md | 2 +- docs/wiki/artistresource/store/index.md | 2 +- docs/wiki/artistresource/update/index.md | 2 +- docs/wiki/artistsong/destroy/index.md | 2 +- docs/wiki/artistsong/store/index.md | 2 +- docs/wiki/artistsong/update/index.md | 2 +- docs/wiki/audio/destroy/index.md | 2 +- docs/wiki/audio/restore/index.md | 2 +- docs/wiki/audio/store/index.md | 2 +- docs/wiki/audio/update/index.md | 2 +- docs/wiki/group/destroy/index.md | 49 ++++++++++ docs/wiki/group/forceDelete/index.md | 39 ++++++++ docs/wiki/group/index.md | 59 ++++++++++++ docs/wiki/group/index/index.md | 94 +++++++++++++++++++ docs/wiki/group/restore/index.md | 49 ++++++++++ docs/wiki/group/show/index.md | 50 ++++++++++ docs/wiki/group/store/index.md | 51 ++++++++++ docs/wiki/group/update/index.md | 53 +++++++++++ docs/wiki/image/destroy/index.md | 2 +- docs/wiki/image/restore/index.md | 2 +- docs/wiki/image/store/index.md | 2 +- docs/wiki/image/update/index.md | 2 +- docs/wiki/index.md | 4 + docs/wiki/resource/destroy/index.md | 2 +- docs/wiki/resource/restore/index.md | 2 +- docs/wiki/resource/store/index.md | 2 +- docs/wiki/resource/update/index.md | 2 +- docs/wiki/series/destroy/index.md | 2 +- docs/wiki/series/restore/index.md | 2 +- docs/wiki/series/store/index.md | 2 +- docs/wiki/series/update/index.md | 2 +- docs/wiki/song/destroy/index.md | 2 +- docs/wiki/song/restore/index.md | 2 +- docs/wiki/song/store/index.md | 2 +- docs/wiki/song/update/index.md | 4 +- docs/wiki/songresource/destroy/index.md | 2 +- docs/wiki/songresource/store/index.md | 2 +- docs/wiki/songresource/update/index.md | 2 +- docs/wiki/studio/destroy/index.md | 2 +- docs/wiki/studio/restore/index.md | 2 +- docs/wiki/studio/store/index.md | 2 +- docs/wiki/studio/update/index.md | 2 +- docs/wiki/studioimage/destroy/index.md | 2 +- docs/wiki/studioimage/store/index.md | 2 +- docs/wiki/studioresource/destroy/index.md | 2 +- docs/wiki/studioresource/store/index.md | 2 +- docs/wiki/studioresource/update/index.md | 2 +- docs/wiki/video/destroy/index.md | 2 +- docs/wiki/video/restore/index.md | 2 +- docs/wiki/video/store/index.md | 2 +- docs/wiki/video/update/index.md | 2 +- docs/wiki/videoscript/destroy/index.md | 2 +- docs/wiki/videoscript/restore/index.md | 2 +- docs/wiki/videoscript/store/index.md | 2 +- docs/wiki/videoscript/update/index.md | 2 +- 100 files changed, 552 insertions(+), 98 deletions(-) create mode 100644 docs/wiki/group/destroy/index.md create mode 100644 docs/wiki/group/forceDelete/index.md create mode 100644 docs/wiki/group/index.md create mode 100644 docs/wiki/group/index/index.md create mode 100644 docs/wiki/group/restore/index.md create mode 100644 docs/wiki/group/show/index.md create mode 100644 docs/wiki/group/store/index.md create mode 100644 docs/wiki/group/update/index.md diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index ca29bad..58a1905 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -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, diff --git a/docs/document/page/destroy/index.md b/docs/document/page/destroy/index.md index a60fcd9..2ad96f0 100644 --- a/docs/document/page/destroy/index.md +++ b/docs/document/page/destroy/index.md @@ -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 diff --git a/docs/document/page/restore/index.md b/docs/document/page/restore/index.md index 0044b2e..b8cf3fd 100644 --- a/docs/document/page/restore/index.md +++ b/docs/document/page/restore/index.md @@ -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 diff --git a/docs/document/page/store/index.md b/docs/document/page/store/index.md index aacbcad..a1c8ebe 100644 --- a/docs/document/page/store/index.md +++ b/docs/document/page/store/index.md @@ -18,7 +18,7 @@ POST /page **Required Permission**: create page -**Roles with Permission**: Wiki Editor, Admin +**Roles with Permission**: Wiki Editor, Encoder, Admin ## Parameters diff --git a/docs/document/page/update/index.md b/docs/document/page/update/index.md index 69529dd..deac743 100644 --- a/docs/document/page/update/index.md +++ b/docs/document/page/update/index.md @@ -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 diff --git a/docs/wiki/anime/destroy/index.md b/docs/wiki/anime/destroy/index.md index 37003d5..f17a9f9 100644 --- a/docs/wiki/anime/destroy/index.md +++ b/docs/wiki/anime/destroy/index.md @@ -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 diff --git a/docs/wiki/anime/index.md b/docs/wiki/anime/index.md index d1dc6a2..8db24bc 100644 --- a/docs/wiki/anime/index.md +++ b/docs/wiki/anime/index.md @@ -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 diff --git a/docs/wiki/anime/restore/index.md b/docs/wiki/anime/restore/index.md index 0a27a2a..f3c49fe 100644 --- a/docs/wiki/anime/restore/index.md +++ b/docs/wiki/anime/restore/index.md @@ -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 diff --git a/docs/wiki/anime/store/index.md b/docs/wiki/anime/store/index.md index 295e005..f06d033 100644 --- a/docs/wiki/anime/store/index.md +++ b/docs/wiki/anime/store/index.md @@ -18,7 +18,7 @@ POST /anime **Required Permission**: create anime -**Roles with Permission**: Wiki Editor, Admin +**Roles with Permission**: Wiki Editor, Encoder, Admin ## Parameters diff --git a/docs/wiki/anime/update/index.md b/docs/wiki/anime/update/index.md index c161c22..00b2809 100644 --- a/docs/wiki/anime/update/index.md +++ b/docs/wiki/anime/update/index.md @@ -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 diff --git a/docs/wiki/animeimage/destroy/index.md b/docs/wiki/animeimage/destroy/index.md index 67cd85f..275ce21 100644 --- a/docs/wiki/animeimage/destroy/index.md +++ b/docs/wiki/animeimage/destroy/index.md @@ -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 diff --git a/docs/wiki/animeimage/store/index.md b/docs/wiki/animeimage/store/index.md index ce59f06..3c7feaf 100644 --- a/docs/wiki/animeimage/store/index.md +++ b/docs/wiki/animeimage/store/index.md @@ -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 diff --git a/docs/wiki/animeresource/destroy/index.md b/docs/wiki/animeresource/destroy/index.md index 4ac1dee..fcbf261 100644 --- a/docs/wiki/animeresource/destroy/index.md +++ b/docs/wiki/animeresource/destroy/index.md @@ -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 diff --git a/docs/wiki/animeresource/store/index.md b/docs/wiki/animeresource/store/index.md index 44093d5..17a7ee1 100644 --- a/docs/wiki/animeresource/store/index.md +++ b/docs/wiki/animeresource/store/index.md @@ -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 diff --git a/docs/wiki/animeresource/update/index.md b/docs/wiki/animeresource/update/index.md index e700de5..1cd189e 100644 --- a/docs/wiki/animeresource/update/index.md +++ b/docs/wiki/animeresource/update/index.md @@ -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 diff --git a/docs/wiki/animeseries/destroy/index.md b/docs/wiki/animeseries/destroy/index.md index 7af9a93..ada038c 100644 --- a/docs/wiki/animeseries/destroy/index.md +++ b/docs/wiki/animeseries/destroy/index.md @@ -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 diff --git a/docs/wiki/animeseries/store/index.md b/docs/wiki/animeseries/store/index.md index c21941e..1909444 100644 --- a/docs/wiki/animeseries/store/index.md +++ b/docs/wiki/animeseries/store/index.md @@ -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 diff --git a/docs/wiki/animestudio/destroy/index.md b/docs/wiki/animestudio/destroy/index.md index fbee0b6..88ac404 100644 --- a/docs/wiki/animestudio/destroy/index.md +++ b/docs/wiki/animestudio/destroy/index.md @@ -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 diff --git a/docs/wiki/animestudio/store/index.md b/docs/wiki/animestudio/store/index.md index 46dea08..83a9dfe 100644 --- a/docs/wiki/animestudio/store/index.md +++ b/docs/wiki/animestudio/store/index.md @@ -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 diff --git a/docs/wiki/animesynonym/destroy/index.md b/docs/wiki/animesynonym/destroy/index.md index 373f8fa..020401a 100644 --- a/docs/wiki/animesynonym/destroy/index.md +++ b/docs/wiki/animesynonym/destroy/index.md @@ -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 diff --git a/docs/wiki/animesynonym/restore/index.md b/docs/wiki/animesynonym/restore/index.md index bb3c507..7ecf16d 100644 --- a/docs/wiki/animesynonym/restore/index.md +++ b/docs/wiki/animesynonym/restore/index.md @@ -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 diff --git a/docs/wiki/animesynonym/store/index.md b/docs/wiki/animesynonym/store/index.md index 06e7c87..7bdc97d 100644 --- a/docs/wiki/animesynonym/store/index.md +++ b/docs/wiki/animesynonym/store/index.md @@ -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 diff --git a/docs/wiki/animesynonym/update/index.md b/docs/wiki/animesynonym/update/index.md index 35c2e59..1e9cd7e 100644 --- a/docs/wiki/animesynonym/update/index.md +++ b/docs/wiki/animesynonym/update/index.md @@ -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 diff --git a/docs/wiki/animetheme/destroy/index.md b/docs/wiki/animetheme/destroy/index.md index 2c5fe9d..2c83fa8 100644 --- a/docs/wiki/animetheme/destroy/index.md +++ b/docs/wiki/animetheme/destroy/index.md @@ -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", diff --git a/docs/wiki/animetheme/index.md b/docs/wiki/animetheme/index.md index ca5fa12..299b631 100644 --- a/docs/wiki/animetheme/index.md +++ b/docs/wiki/animetheme/index.md @@ -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 diff --git a/docs/wiki/animetheme/index/index.md b/docs/wiki/animetheme/index/index.md index e368868..f5fecc9 100644 --- a/docs/wiki/animetheme/index/index.md +++ b/docs/wiki/animetheme/index/index.md @@ -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", diff --git a/docs/wiki/animetheme/restore/index.md b/docs/wiki/animetheme/restore/index.md index c8010c6..87b474e 100644 --- a/docs/wiki/animetheme/restore/index.md +++ b/docs/wiki/animetheme/restore/index.md @@ -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", diff --git a/docs/wiki/animetheme/show/index.md b/docs/wiki/animetheme/show/index.md index 81c77da..ac7838c 100644 --- a/docs/wiki/animetheme/show/index.md +++ b/docs/wiki/animetheme/show/index.md @@ -35,7 +35,6 @@ None id: id, type: "type", sequence: sequence, - group: "group", slug: "slug", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/wiki/animetheme/store/index.md b/docs/wiki/animetheme/store/index.md index 78afffc..7535c9c 100644 --- a/docs/wiki/animetheme/store/index.md +++ b/docs/wiki/animetheme/store/index.md @@ -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", diff --git a/docs/wiki/animetheme/update/index.md b/docs/wiki/animetheme/update/index.md index e43c1d8..a1aba00 100644 --- a/docs/wiki/animetheme/update/index.md +++ b/docs/wiki/animetheme/update/index.md @@ -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", diff --git a/docs/wiki/animethemeentry/destroy/index.md b/docs/wiki/animethemeentry/destroy/index.md index 023ba6d..0a6c461 100644 --- a/docs/wiki/animethemeentry/destroy/index.md +++ b/docs/wiki/animethemeentry/destroy/index.md @@ -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 diff --git a/docs/wiki/animethemeentry/restore/index.md b/docs/wiki/animethemeentry/restore/index.md index e8ddcbb..ab4bad2 100644 --- a/docs/wiki/animethemeentry/restore/index.md +++ b/docs/wiki/animethemeentry/restore/index.md @@ -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 diff --git a/docs/wiki/animethemeentry/store/index.md b/docs/wiki/animethemeentry/store/index.md index 01e2e79..fc7d642 100644 --- a/docs/wiki/animethemeentry/store/index.md +++ b/docs/wiki/animethemeentry/store/index.md @@ -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 diff --git a/docs/wiki/animethemeentry/update/index.md b/docs/wiki/animethemeentry/update/index.md index e137469..b567e99 100644 --- a/docs/wiki/animethemeentry/update/index.md +++ b/docs/wiki/animethemeentry/update/index.md @@ -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 diff --git a/docs/wiki/animethemeentryvideo/destroy/index.md b/docs/wiki/animethemeentryvideo/destroy/index.md index da77971..065e821 100644 --- a/docs/wiki/animethemeentryvideo/destroy/index.md +++ b/docs/wiki/animethemeentryvideo/destroy/index.md @@ -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 diff --git a/docs/wiki/animethemeentryvideo/store/index.md b/docs/wiki/animethemeentryvideo/store/index.md index c1a807a..9a1843a 100644 --- a/docs/wiki/animethemeentryvideo/store/index.md +++ b/docs/wiki/animethemeentryvideo/store/index.md @@ -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 diff --git a/docs/wiki/artist/destroy/index.md b/docs/wiki/artist/destroy/index.md index 76089e4..ade3d91 100644 --- a/docs/wiki/artist/destroy/index.md +++ b/docs/wiki/artist/destroy/index.md @@ -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 diff --git a/docs/wiki/artist/restore/index.md b/docs/wiki/artist/restore/index.md index 4d1f10f..52f17cd 100644 --- a/docs/wiki/artist/restore/index.md +++ b/docs/wiki/artist/restore/index.md @@ -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 diff --git a/docs/wiki/artist/store/index.md b/docs/wiki/artist/store/index.md index 2e43e77..9d9d93b 100644 --- a/docs/wiki/artist/store/index.md +++ b/docs/wiki/artist/store/index.md @@ -18,7 +18,7 @@ POST /artist **Required Permission**: create artist -**Roles with Permission**: Wiki Editor, Admin +**Roles with Permission**: Wiki Editor, Encoder, Admin ## Parameters diff --git a/docs/wiki/artist/update/index.md b/docs/wiki/artist/update/index.md index 41528fd..0fd7251 100644 --- a/docs/wiki/artist/update/index.md +++ b/docs/wiki/artist/update/index.md @@ -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 diff --git a/docs/wiki/artistimage/destroy/index.md b/docs/wiki/artistimage/destroy/index.md index e8be570..2f74e4d 100644 --- a/docs/wiki/artistimage/destroy/index.md +++ b/docs/wiki/artistimage/destroy/index.md @@ -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 diff --git a/docs/wiki/artistimage/store/index.md b/docs/wiki/artistimage/store/index.md index 54fc5df..61bf7b7 100644 --- a/docs/wiki/artistimage/store/index.md +++ b/docs/wiki/artistimage/store/index.md @@ -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 diff --git a/docs/wiki/artistmember/destroy/index.md b/docs/wiki/artistmember/destroy/index.md index 5f65ddc..1c2d1cb 100644 --- a/docs/wiki/artistmember/destroy/index.md +++ b/docs/wiki/artistmember/destroy/index.md @@ -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 diff --git a/docs/wiki/artistmember/store/index.md b/docs/wiki/artistmember/store/index.md index 2741e52..5950736 100644 --- a/docs/wiki/artistmember/store/index.md +++ b/docs/wiki/artistmember/store/index.md @@ -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 diff --git a/docs/wiki/artistmember/update/index.md b/docs/wiki/artistmember/update/index.md index 5fc44dc..77cf86f 100644 --- a/docs/wiki/artistmember/update/index.md +++ b/docs/wiki/artistmember/update/index.md @@ -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 diff --git a/docs/wiki/artistresource/destroy/index.md b/docs/wiki/artistresource/destroy/index.md index 200d7bf..d55ed94 100644 --- a/docs/wiki/artistresource/destroy/index.md +++ b/docs/wiki/artistresource/destroy/index.md @@ -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 diff --git a/docs/wiki/artistresource/store/index.md b/docs/wiki/artistresource/store/index.md index 9c8ccad..8298db2 100644 --- a/docs/wiki/artistresource/store/index.md +++ b/docs/wiki/artistresource/store/index.md @@ -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 diff --git a/docs/wiki/artistresource/update/index.md b/docs/wiki/artistresource/update/index.md index ec836f0..f960dc6 100644 --- a/docs/wiki/artistresource/update/index.md +++ b/docs/wiki/artistresource/update/index.md @@ -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 diff --git a/docs/wiki/artistsong/destroy/index.md b/docs/wiki/artistsong/destroy/index.md index d825d62..9bb51d8 100644 --- a/docs/wiki/artistsong/destroy/index.md +++ b/docs/wiki/artistsong/destroy/index.md @@ -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 diff --git a/docs/wiki/artistsong/store/index.md b/docs/wiki/artistsong/store/index.md index 93cd9e4..09434f8 100644 --- a/docs/wiki/artistsong/store/index.md +++ b/docs/wiki/artistsong/store/index.md @@ -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 diff --git a/docs/wiki/artistsong/update/index.md b/docs/wiki/artistsong/update/index.md index 6171c0c..2b9ef16 100644 --- a/docs/wiki/artistsong/update/index.md +++ b/docs/wiki/artistsong/update/index.md @@ -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 diff --git a/docs/wiki/audio/destroy/index.md b/docs/wiki/audio/destroy/index.md index 425315a..edb24e0 100644 --- a/docs/wiki/audio/destroy/index.md +++ b/docs/wiki/audio/destroy/index.md @@ -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 diff --git a/docs/wiki/audio/restore/index.md b/docs/wiki/audio/restore/index.md index b7e1ba7..cfc2e5d 100644 --- a/docs/wiki/audio/restore/index.md +++ b/docs/wiki/audio/restore/index.md @@ -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 diff --git a/docs/wiki/audio/store/index.md b/docs/wiki/audio/store/index.md index cb003c9..aad6cbc 100644 --- a/docs/wiki/audio/store/index.md +++ b/docs/wiki/audio/store/index.md @@ -18,7 +18,7 @@ POST /audio **Required Permission**: create audio -**Roles with Permission**: Admin +**Roles with Permission**: Encoder, Admin ## Parameters diff --git a/docs/wiki/audio/update/index.md b/docs/wiki/audio/update/index.md index c55960b..7b7a4a1 100644 --- a/docs/wiki/audio/update/index.md +++ b/docs/wiki/audio/update/index.md @@ -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 diff --git a/docs/wiki/group/destroy/index.md b/docs/wiki/group/destroy/index.md new file mode 100644 index 0000000..b9260ad --- /dev/null +++ b/docs/wiki/group/destroy/index.md @@ -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 +``` diff --git a/docs/wiki/group/forceDelete/index.md b/docs/wiki/group/forceDelete/index.md new file mode 100644 index 0000000..3c63de1 --- /dev/null +++ b/docs/wiki/group/forceDelete/index.md @@ -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 +``` diff --git a/docs/wiki/group/index.md b/docs/wiki/group/index.md new file mode 100644 index 0000000..789f99b --- /dev/null +++ b/docs/wiki/group/index.md @@ -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. \ No newline at end of file diff --git a/docs/wiki/group/index/index.md b/docs/wiki/group/index/index.md new file mode 100644 index 0000000..db0e8c2 --- /dev/null +++ b/docs/wiki/group/index/index.md @@ -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/ +``` diff --git a/docs/wiki/group/restore/index.md b/docs/wiki/group/restore/index.md new file mode 100644 index 0000000..14396e6 --- /dev/null +++ b/docs/wiki/group/restore/index.md @@ -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 +``` diff --git a/docs/wiki/group/show/index.md b/docs/wiki/group/show/index.md new file mode 100644 index 0000000..290e179 --- /dev/null +++ b/docs/wiki/group/show/index.md @@ -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 +``` diff --git a/docs/wiki/group/store/index.md b/docs/wiki/group/store/index.md new file mode 100644 index 0000000..16d7589 --- /dev/null +++ b/docs/wiki/group/store/index.md @@ -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/ +``` diff --git a/docs/wiki/group/update/index.md b/docs/wiki/group/update/index.md new file mode 100644 index 0000000..e580682 --- /dev/null +++ b/docs/wiki/group/update/index.md @@ -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 +``` diff --git a/docs/wiki/image/destroy/index.md b/docs/wiki/image/destroy/index.md index be5114a..cee42cc 100644 --- a/docs/wiki/image/destroy/index.md +++ b/docs/wiki/image/destroy/index.md @@ -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 diff --git a/docs/wiki/image/restore/index.md b/docs/wiki/image/restore/index.md index 8d277f3..94ac28b 100644 --- a/docs/wiki/image/restore/index.md +++ b/docs/wiki/image/restore/index.md @@ -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 diff --git a/docs/wiki/image/store/index.md b/docs/wiki/image/store/index.md index 3347e32..941945a 100644 --- a/docs/wiki/image/store/index.md +++ b/docs/wiki/image/store/index.md @@ -18,7 +18,7 @@ POST /image **Required Permission**: create image -**Roles with Permission**: Wiki Editor, Admin +**Roles with Permission**: Wiki Editor, Encoder, Admin ## Parameters diff --git a/docs/wiki/image/update/index.md b/docs/wiki/image/update/index.md index 40150a3..69f6750 100644 --- a/docs/wiki/image/update/index.md +++ b/docs/wiki/image/update/index.md @@ -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 diff --git a/docs/wiki/index.md b/docs/wiki/index.md index 9da78e1..0b680d0 100644 --- a/docs/wiki/index.md +++ b/docs/wiki/index.md @@ -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. diff --git a/docs/wiki/resource/destroy/index.md b/docs/wiki/resource/destroy/index.md index 1fc1eb5..45e1042 100644 --- a/docs/wiki/resource/destroy/index.md +++ b/docs/wiki/resource/destroy/index.md @@ -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 diff --git a/docs/wiki/resource/restore/index.md b/docs/wiki/resource/restore/index.md index faf5a2b..f468271 100644 --- a/docs/wiki/resource/restore/index.md +++ b/docs/wiki/resource/restore/index.md @@ -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 diff --git a/docs/wiki/resource/store/index.md b/docs/wiki/resource/store/index.md index 8ade472..335e7e1 100644 --- a/docs/wiki/resource/store/index.md +++ b/docs/wiki/resource/store/index.md @@ -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 diff --git a/docs/wiki/resource/update/index.md b/docs/wiki/resource/update/index.md index c227568..23d9657 100644 --- a/docs/wiki/resource/update/index.md +++ b/docs/wiki/resource/update/index.md @@ -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 diff --git a/docs/wiki/series/destroy/index.md b/docs/wiki/series/destroy/index.md index c356499..7bf600a 100644 --- a/docs/wiki/series/destroy/index.md +++ b/docs/wiki/series/destroy/index.md @@ -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 diff --git a/docs/wiki/series/restore/index.md b/docs/wiki/series/restore/index.md index f1ecfa7..e81bed0 100644 --- a/docs/wiki/series/restore/index.md +++ b/docs/wiki/series/restore/index.md @@ -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 diff --git a/docs/wiki/series/store/index.md b/docs/wiki/series/store/index.md index a6ce45d..5bdd5e7 100644 --- a/docs/wiki/series/store/index.md +++ b/docs/wiki/series/store/index.md @@ -18,7 +18,7 @@ POST /series **Required Permission**: create series -**Roles with Permission**: Wiki Editor, Admin +**Roles with Permission**: Wiki Editor, Encoder, Admin ## Parameters diff --git a/docs/wiki/series/update/index.md b/docs/wiki/series/update/index.md index 8341f1a..a68536c 100644 --- a/docs/wiki/series/update/index.md +++ b/docs/wiki/series/update/index.md @@ -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 diff --git a/docs/wiki/song/destroy/index.md b/docs/wiki/song/destroy/index.md index 816f47d..3d6b1ab 100644 --- a/docs/wiki/song/destroy/index.md +++ b/docs/wiki/song/destroy/index.md @@ -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 diff --git a/docs/wiki/song/restore/index.md b/docs/wiki/song/restore/index.md index c70066c..54e06d0 100644 --- a/docs/wiki/song/restore/index.md +++ b/docs/wiki/song/restore/index.md @@ -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 diff --git a/docs/wiki/song/store/index.md b/docs/wiki/song/store/index.md index 1c05ae4..69b945d 100644 --- a/docs/wiki/song/store/index.md +++ b/docs/wiki/song/store/index.md @@ -18,7 +18,7 @@ POST /song **Required Permission**: create song -**Roles with Permission**: Wiki Editor, Admin +**Roles with Permission**: Wiki Editor, Encoder, Admin ## Parameters diff --git a/docs/wiki/song/update/index.md b/docs/wiki/song/update/index.md index 44b913a..6b6c128 100644 --- a/docs/wiki/song/update/index.md +++ b/docs/wiki/song/update/index.md @@ -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 diff --git a/docs/wiki/songresource/destroy/index.md b/docs/wiki/songresource/destroy/index.md index 29eae99..65ef964 100644 --- a/docs/wiki/songresource/destroy/index.md +++ b/docs/wiki/songresource/destroy/index.md @@ -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 diff --git a/docs/wiki/songresource/store/index.md b/docs/wiki/songresource/store/index.md index 1be7e12..0f8b390 100644 --- a/docs/wiki/songresource/store/index.md +++ b/docs/wiki/songresource/store/index.md @@ -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 diff --git a/docs/wiki/songresource/update/index.md b/docs/wiki/songresource/update/index.md index de0c19d..da57c7b 100644 --- a/docs/wiki/songresource/update/index.md +++ b/docs/wiki/songresource/update/index.md @@ -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 diff --git a/docs/wiki/studio/destroy/index.md b/docs/wiki/studio/destroy/index.md index af709cc..340293c 100644 --- a/docs/wiki/studio/destroy/index.md +++ b/docs/wiki/studio/destroy/index.md @@ -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 diff --git a/docs/wiki/studio/restore/index.md b/docs/wiki/studio/restore/index.md index 1b8762f..0d491c2 100644 --- a/docs/wiki/studio/restore/index.md +++ b/docs/wiki/studio/restore/index.md @@ -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 diff --git a/docs/wiki/studio/store/index.md b/docs/wiki/studio/store/index.md index 30b0bd1..574d692 100644 --- a/docs/wiki/studio/store/index.md +++ b/docs/wiki/studio/store/index.md @@ -18,7 +18,7 @@ POST /studio **Required Permission**: create studio -**Roles with Permission**: Wiki Editor, Admin +**Roles with Permission**: Wiki Editor, Encoder, Admin ## Parameters diff --git a/docs/wiki/studio/update/index.md b/docs/wiki/studio/update/index.md index 08e54eb..153d838 100644 --- a/docs/wiki/studio/update/index.md +++ b/docs/wiki/studio/update/index.md @@ -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 diff --git a/docs/wiki/studioimage/destroy/index.md b/docs/wiki/studioimage/destroy/index.md index ff9fa73..93644aa 100644 --- a/docs/wiki/studioimage/destroy/index.md +++ b/docs/wiki/studioimage/destroy/index.md @@ -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 diff --git a/docs/wiki/studioimage/store/index.md b/docs/wiki/studioimage/store/index.md index 371ea58..bf46c80 100644 --- a/docs/wiki/studioimage/store/index.md +++ b/docs/wiki/studioimage/store/index.md @@ -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 diff --git a/docs/wiki/studioresource/destroy/index.md b/docs/wiki/studioresource/destroy/index.md index f03f7bd..897b63f 100644 --- a/docs/wiki/studioresource/destroy/index.md +++ b/docs/wiki/studioresource/destroy/index.md @@ -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 diff --git a/docs/wiki/studioresource/store/index.md b/docs/wiki/studioresource/store/index.md index d48da53..c91b5bf 100644 --- a/docs/wiki/studioresource/store/index.md +++ b/docs/wiki/studioresource/store/index.md @@ -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 diff --git a/docs/wiki/studioresource/update/index.md b/docs/wiki/studioresource/update/index.md index d70f20d..ea53b74 100644 --- a/docs/wiki/studioresource/update/index.md +++ b/docs/wiki/studioresource/update/index.md @@ -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 diff --git a/docs/wiki/video/destroy/index.md b/docs/wiki/video/destroy/index.md index a71702a..7139e03 100644 --- a/docs/wiki/video/destroy/index.md +++ b/docs/wiki/video/destroy/index.md @@ -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 diff --git a/docs/wiki/video/restore/index.md b/docs/wiki/video/restore/index.md index b1035ab..eb03807 100644 --- a/docs/wiki/video/restore/index.md +++ b/docs/wiki/video/restore/index.md @@ -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 diff --git a/docs/wiki/video/store/index.md b/docs/wiki/video/store/index.md index f793576..8d9c061 100644 --- a/docs/wiki/video/store/index.md +++ b/docs/wiki/video/store/index.md @@ -18,7 +18,7 @@ POST /video **Required Permission**: create video -**Roles with Permission**: Admin +**Roles with Permission**: Encoder, Admin ## Parameters diff --git a/docs/wiki/video/update/index.md b/docs/wiki/video/update/index.md index 06a111c..fa11378 100644 --- a/docs/wiki/video/update/index.md +++ b/docs/wiki/video/update/index.md @@ -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 diff --git a/docs/wiki/videoscript/destroy/index.md b/docs/wiki/videoscript/destroy/index.md index ced5b3a..db01989 100644 --- a/docs/wiki/videoscript/destroy/index.md +++ b/docs/wiki/videoscript/destroy/index.md @@ -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 diff --git a/docs/wiki/videoscript/restore/index.md b/docs/wiki/videoscript/restore/index.md index 861f2e4..fc053f2 100644 --- a/docs/wiki/videoscript/restore/index.md +++ b/docs/wiki/videoscript/restore/index.md @@ -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 diff --git a/docs/wiki/videoscript/store/index.md b/docs/wiki/videoscript/store/index.md index 0ca72fe..2fe7d57 100644 --- a/docs/wiki/videoscript/store/index.md +++ b/docs/wiki/videoscript/store/index.md @@ -18,7 +18,7 @@ POST /videoscript **Required Permission**: create video script -**Roles with Permission**: Admin +**Roles with Permission**: Encoder, Admin ## Parameters diff --git a/docs/wiki/videoscript/update/index.md b/docs/wiki/videoscript/update/index.md index 4a3ca44..9888b0d 100644 --- a/docs/wiki/videoscript/update/index.md +++ b/docs/wiki/videoscript/update/index.md @@ -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