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: adding playlist views field (#64)

Browse Source
This commit is contained in:
paranarimasu
2023-01-29 00:10:52 -06:00
committed by Maniload
parent e762d9ae3c
commit 1ea9fe214f
2 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/list/playlist/index.md
+9 -8
View File
@@ -12,14 +12,15 @@ For example, a "/r/anime's Best OPs and EDs of 2022" playlist may contain a coll
## Fields
| Name | Type | Nullable | Description |
| :--------: | :-----: | :------: | :---------------------------------------------------------------- |
| id | Integer | No | The primary key of the resource |
| name | String | No | The title of the playlist |
| visibility | Enum | Yes | The state of who can see the playlist [Private, Unlisted, Public] |
| created_at | Date | No | The date that the resource was created |
| updated_at | Date | No | The date that the resource was last modified |
| deleted_at | Date | Yes | The date that the resource was deleted |
| Name | Type | Nullable | Description |
| :--------: | :-----: | :------: | :-------------------------------------------------------------------------- |
| id | Integer | No | The primary key of the resource |
| name | String | No | The title of the playlist |
| visibility | Enum | Yes | The state of who can see the playlist [Private, Unlisted, Public] |
| created_at | Date | No | The date that the resource was created |
| updated_at | Date | No | The date that the resource was last modified |
| deleted_at | Date | Yes | The date that the resource was deleted |
| views | Integer | No | The number of views recorded for the resource. Must be explicitly included. |
## Allowed Include Paths
docs/list/playlist/index/index.md
+2
View File
@@ -35,6 +35,7 @@ GET /playlist/
| 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 |
| views | Sort resources on the number of recorded views |
| 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 |
@@ -47,6 +48,7 @@ GET /playlist/
| 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] |
| views | Filter resources on the number of recorded views |
| 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 |