From 0a533bed99e6d526b3dd8af650d6b9bc84202804 Mon Sep 17 00:00:00 2001 From: Kyrch Date: Mon, 27 May 2024 22:18:51 -0300 Subject: [PATCH] feat: added playlist description field (#102) --- docs/admin/featuredtheme/index.md | 1 + docs/auth/role/index.md | 6 +++- docs/auth/user/me/index.md | 1 + docs/auth/user/me/playlist/index.md | 41 ++++++++++++---------- docs/list/playlist/backward/index.md | 1 + docs/list/playlist/destroy/index.md | 1 + docs/list/playlist/forward/index.md | 1 + docs/list/playlist/index.md | 1 + docs/list/playlist/index/index.md | 3 ++ docs/list/playlist/restore/index.md | 1 + docs/list/playlist/show/index.md | 1 + docs/list/playlist/store/index.md | 10 +++--- docs/list/playlist/track/backward/index.md | 1 + docs/list/playlist/track/forward/index.md | 1 + docs/list/playlist/update/index.md | 10 +++--- docs/search/index.md | 1 + docs/wiki/artist/index.md | 1 + docs/wiki/song/index.md | 1 + docs/wiki/video/index.md | 1 + 19 files changed, 56 insertions(+), 28 deletions(-) diff --git a/docs/admin/featuredtheme/index.md b/docs/admin/featuredtheme/index.md index 220b718..dee8343 100644 --- a/docs/admin/featuredtheme/index.md +++ b/docs/admin/featuredtheme/index.md @@ -25,6 +25,7 @@ A featured theme API resource represents a video to be featured on the homepage * animethemeentry.animetheme * animethemeentry.animetheme.anime * animethemeentry.animetheme.anime.images +* animethemeentry.animetheme.group * animethemeentry.animetheme.song * animethemeentry.animetheme.song.artists * user diff --git a/docs/auth/role/index.md b/docs/auth/role/index.md index 2b10485..472e786 100644 --- a/docs/auth/role/index.md +++ b/docs/auth/role/index.md @@ -19,4 +19,8 @@ A role API resource represents an assignable label for users that provides a con | color | String | Yes | Yes | The hex representation of the color used to distinguish the resource | | priority | Integer | Yes | Yes | The weight assigned to the resource, where higher values correspond to higher priority | | 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 | \ No newline at end of file +| updated_at | Date | No | No | The date that the resource was last modified | + +## Allowed Include Paths + +* permissions \ No newline at end of file diff --git a/docs/auth/user/me/index.md b/docs/auth/user/me/index.md index 23c0a7a..96fe9d8 100644 --- a/docs/auth/user/me/index.md +++ b/docs/auth/user/me/index.md @@ -26,6 +26,7 @@ The "Me" namespace is a collection of endpoints that pertain to the currently au * permissions * playlists * roles +* roles.permissions ## Endpoints diff --git a/docs/auth/user/me/playlist/index.md b/docs/auth/user/me/playlist/index.md index 28e95c1..f745a77 100644 --- a/docs/auth/user/me/playlist/index.md +++ b/docs/auth/user/me/playlist/index.md @@ -29,28 +29,30 @@ GET /me/playlist/ ## Allowed Sort Fields -| Name | Description | -| :--------: | :------------------------------------------------------------------ | -| id | Sort resources on the primary key | -| name | Sort resources on the title of the playlist | -| visibility | Sort resources on the visibility state of the playlist | -| 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. | +| Name | Description | +| :---------: | :------------------------------------------------------------------ | +| id | Sort resources on the primary key | +| name | Sort resources on the title of the playlist | +| description | Sort resources on the description of the playlist | +| visibility | Sort resources on the visibility state of the playlist | +| 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 | -| name | Filter resources on the title of the playlist | -| visibility | Filter resources on the visibility state of the playlist [Public, Private, Unlisted] | -| 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 | +| Name | Description | +| :---------: | :----------------------------------------------------------------------------------- | +| id | Filter resources on the primary key | +| name | Filter resources on the title of the playlist | +| description | Filter resources on the description of the playlist | +| visibility | Filter resources on the visibility state of the playlist [Public, Private, Unlisted] | +| 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 @@ -60,6 +62,7 @@ GET /me/playlist/ { id: id, name: "name", + description: "description", visibility: "visibility", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/list/playlist/backward/index.md b/docs/list/playlist/backward/index.md index aca148e..9885be3 100644 --- a/docs/list/playlist/backward/index.md +++ b/docs/list/playlist/backward/index.md @@ -31,6 +31,7 @@ GET /playlist/{id}/backward * video * video.animethemeentries.animetheme.anime.images +* video.animethemeentries.animetheme.group * video.animethemeentries.animetheme.song.artists * video.audio diff --git a/docs/list/playlist/destroy/index.md b/docs/list/playlist/destroy/index.md index 7eeedc4..94d6cea 100644 --- a/docs/list/playlist/destroy/index.md +++ b/docs/list/playlist/destroy/index.md @@ -31,6 +31,7 @@ None playlist: { id: "id", name: "name", + description: "description", visibility: "visibility", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/list/playlist/forward/index.md b/docs/list/playlist/forward/index.md index 304d1fe..bcbd921 100644 --- a/docs/list/playlist/forward/index.md +++ b/docs/list/playlist/forward/index.md @@ -31,6 +31,7 @@ GET /playlist/{id}/forward * video * video.animethemeentries.animetheme.anime.images +* video.animethemeentries.animetheme.group * video.animethemeentries.animetheme.song.artists * video.audio diff --git a/docs/list/playlist/index.md b/docs/list/playlist/index.md index 242f709..707d8ee 100644 --- a/docs/list/playlist/index.md +++ b/docs/list/playlist/index.md @@ -16,6 +16,7 @@ For example, a "/r/anime's Best OPs and EDs of 2022" playlist may contain a coll | :-----------: | :-----: | :------: | :-----: | :---------------------------------------------------------------- | | id | String | No | Yes | The primary key of the resource | | name | String | No | Yes | The title of the playlist | +| description | String | Yes | No | The description of the playlist | | visibility | Enum | Yes | Yes | The state of who can see the playlist [Private, Unlisted, Public] | | 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 | diff --git a/docs/list/playlist/index/index.md b/docs/list/playlist/index/index.md index 55707b3..5f0eb7a 100644 --- a/docs/list/playlist/index/index.md +++ b/docs/list/playlist/index/index.md @@ -34,6 +34,7 @@ GET /playlist/ | :-----------: | :------------------------------------------------------------------ | | id | Sort resources on the primary key | | name | Sort resources on the title of the playlist | +| description | Sort resources on the description of the playlist | | visibility | Sort resources on the visibility state of the playlist | | views_count | Sort resources on the number of recorded views | | tracks_exists | Sort resources on the existence of tracks | @@ -49,6 +50,7 @@ GET /playlist/ | :-----------: | :----------------------------------------------------------------------------------- | | id | Filter resources on the primary key | | name | Filter resources on the title of the playlist | +| description | Filter resources on the description of the playlist | | visibility | Filter resources on the visibility state of the playlist [Public, Private, Unlisted] | | views_count | Filter resources on the number of recorded views | | tracks_exists | Filter resources on existence of tracks | @@ -67,6 +69,7 @@ GET /playlist/ { id: "id", name: "name", + description: "description", visibility: "visibility", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/list/playlist/restore/index.md b/docs/list/playlist/restore/index.md index 558d310..b93823b 100644 --- a/docs/list/playlist/restore/index.md +++ b/docs/list/playlist/restore/index.md @@ -31,6 +31,7 @@ None playlist: { id: "id", name: "name", + description: "description", visibility: "visibility", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/list/playlist/show/index.md b/docs/list/playlist/show/index.md index 551fe05..37a33e8 100644 --- a/docs/list/playlist/show/index.md +++ b/docs/list/playlist/show/index.md @@ -34,6 +34,7 @@ GET /playlist/{id} playlist: { id: "id", name: "name", + description: "description", visibility: "visibility", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/list/playlist/store/index.md b/docs/list/playlist/store/index.md index 83879d4..f523641 100644 --- a/docs/list/playlist/store/index.md +++ b/docs/list/playlist/store/index.md @@ -20,10 +20,11 @@ POST /playlist ## Parameters -| Name | Required | Rules | -| :--------: | :------: | :------------------------------------ | -| name | Yes | string, max:192 | -| visibility | Yes | EnumValue [Public, Private, Unlisted] | +| Name | Required | Rules | +| :--------: | :------: | :------------------------------------ | +| name | Yes | string, max:192 | +| description | No | string, max:1000 | +| visibility | Yes | EnumValue [Public, Private, Unlisted] | ## Response @@ -32,6 +33,7 @@ POST /playlist playlist: { id: "id", name: "name", + description: "description", visibility: "visibility", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/list/playlist/track/backward/index.md b/docs/list/playlist/track/backward/index.md index 053434b..7ff33f7 100644 --- a/docs/list/playlist/track/backward/index.md +++ b/docs/list/playlist/track/backward/index.md @@ -31,6 +31,7 @@ GET /playlist/{playlist:id}/track/{track:id}/backward * video * video.animethemeentries.animetheme.anime.images +* video.animethemeentries.animetheme.group * video.animethemeentries.animetheme.song.artists * video.audio diff --git a/docs/list/playlist/track/forward/index.md b/docs/list/playlist/track/forward/index.md index 8fdba5e..1b56c57 100644 --- a/docs/list/playlist/track/forward/index.md +++ b/docs/list/playlist/track/forward/index.md @@ -31,6 +31,7 @@ GET /playlist/{playlist:id}/track/{track:id}/forward * video * video.animethemeentries.animetheme.anime.images +* video.animethemeentries.animetheme.group * video.animethemeentries.animetheme.song.artists * video.audio diff --git a/docs/list/playlist/update/index.md b/docs/list/playlist/update/index.md index 73e69d6..0086073 100644 --- a/docs/list/playlist/update/index.md +++ b/docs/list/playlist/update/index.md @@ -24,10 +24,11 @@ PUT|PATCH /playlist/{id} ## Parameters -| Name | Required | Rules | -| :--------: | :------: | :------------------------------------ | -| name | No | string, max:192 | -| visibility | No | EnumValue [Public, Private, Unlisted] | +| Name | Required | Rules | +| :--------: | :------: | :------------------------------------ | +| name | No | string, max:192 | +| description | No | string, max:1000 | +| visibility | No | EnumValue [Public, Private, Unlisted] | ## Response @@ -36,6 +37,7 @@ PUT|PATCH /playlist/{id} playlist: { id: "id", name: "name", + description: "description", visibility: "visibility", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/search/index.md b/docs/search/index.md index 2b8b170..7fa1bb8 100644 --- a/docs/search/index.md +++ b/docs/search/index.md @@ -72,6 +72,7 @@ None { id: id, name: "name", + description: "description", visibility: "visibility", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/wiki/artist/index.md b/docs/wiki/artist/index.md index 830e707..b3e856a 100644 --- a/docs/wiki/artist/index.md +++ b/docs/wiki/artist/index.md @@ -30,6 +30,7 @@ For example, Chiwa Saitou is the musical performer of the Bakemonogatari OP1 the * songs * songs.animethemes * songs.animethemes.anime +* songs.animethemes.group ## Allowed Pivots diff --git a/docs/wiki/song/index.md b/docs/wiki/song/index.md index 6438530..1fc5d98 100644 --- a/docs/wiki/song/index.md +++ b/docs/wiki/song/index.md @@ -24,6 +24,7 @@ For example, Staple Stable is the song for the Bakemonogatari OP1 AnimeTheme. * animethemes * animethemes.anime +* animethemes.group * artists * resources diff --git a/docs/wiki/video/index.md b/docs/wiki/video/index.md index 478948b..af439aa 100644 --- a/docs/wiki/video/index.md +++ b/docs/wiki/video/index.md @@ -39,6 +39,7 @@ For example, the video Bakemonogatari-OP1.webm represents the WebM of the Bakemo * animethemeentries * animethemeentries.animetheme * animethemeentries.animetheme.anime +* animethemeentries.animetheme.group * audio * videoscript