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

feat: added playlist description field (#102)

Browse Source
This commit is contained in:
Kyrch
2024-05-27 22:18:51 -03:00
committed by GitHub
parent 6481770a85
commit 0a533bed99
19 changed files with 56 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/featuredtheme/index.md
+1
View File
@@ -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
docs/auth/role/index.md
+5 -1
View File
@@ -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 |
| updated_at | Date | No | No | The date that the resource was last modified |
## Allowed Include Paths
* permissions
docs/auth/user/me/index.md
+1
View File
@@ -26,6 +26,7 @@ The "Me" namespace is a collection of endpoints that pertain to the currently au
* permissions
* playlists
* roles
* roles.permissions
## Endpoints
docs/auth/user/me/playlist/index.md
+22 -19
View File
@@ -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",
docs/list/playlist/backward/index.md
+1
View File
@@ -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
docs/list/playlist/destroy/index.md
+1
View File
@@ -31,6 +31,7 @@ None
playlist: {
id: "id",
name: "name",
description: "description",
visibility: "visibility",
created_at: "created_at",
updated_at: "updated_at",
docs/list/playlist/forward/index.md
+1
View File
@@ -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
docs/list/playlist/index.md
+1
View File
@@ -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 |
docs/list/playlist/index/index.md
+3
View File
@@ -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",
docs/list/playlist/restore/index.md
+1
View File
@@ -31,6 +31,7 @@ None
playlist: {
id: "id",
name: "name",
description: "description",
visibility: "visibility",
created_at: "created_at",
updated_at: "updated_at",
docs/list/playlist/show/index.md
+1
View File
@@ -34,6 +34,7 @@ GET /playlist/{id}
playlist: {
id: "id",
name: "name",
description: "description",
visibility: "visibility",
created_at: "created_at",
updated_at: "updated_at",
docs/list/playlist/store/index.md
+6 -4
View File
@@ -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",
docs/list/playlist/track/backward/index.md
+1
View File
@@ -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
docs/list/playlist/track/forward/index.md
+1
View File
@@ -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
docs/list/playlist/update/index.md
+6 -4
View File
@@ -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",
docs/search/index.md
+1
View File
@@ -72,6 +72,7 @@ None
{
id: id,
name: "name",
description: "description",
visibility: "visibility",
created_at: "created_at",
updated_at: "updated_at",
docs/wiki/artist/index.md
+1
View File
@@ -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
docs/wiki/song/index.md
+1
View File
@@ -24,6 +24,7 @@ For example, Staple Stable is the song for the Bakemonogatari OP1 AnimeTheme.
* animethemes
* animethemes.anime
* animethemes.group
* artists
* resources
docs/wiki/video/index.md
+1
View File
@@ -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