From 63e16135a96a68e8f05c3f1a1533aab76bbb8e83 Mon Sep 17 00:00:00 2001 From: paranarimasu <33796518+paranarimasu@users.noreply.github.com> Date: Wed, 26 Oct 2022 17:10:19 -0500 Subject: [PATCH] fix: remove dead links from extraneous tracks pages (#51) --- .../playlist/playlisttrack/destroy/index.md | 44 ---------- .../playlisttrack/forceDelete/index.md | 39 --------- docs/list/playlist/playlisttrack/index.md | 53 ------------ .../playlist/playlisttrack/index/index.md | 86 ------------------- .../list/playlist/playlisttrack/show/index.md | 47 ---------- .../playlist/playlisttrack/store/index.md | 47 ---------- .../playlist/playlisttrack/update/index.md | 48 ----------- 7 files changed, 364 deletions(-) delete mode 100644 docs/list/playlist/playlisttrack/destroy/index.md delete mode 100644 docs/list/playlist/playlisttrack/forceDelete/index.md delete mode 100644 docs/list/playlist/playlisttrack/index.md delete mode 100644 docs/list/playlist/playlisttrack/index/index.md delete mode 100644 docs/list/playlist/playlisttrack/show/index.md delete mode 100644 docs/list/playlist/playlisttrack/store/index.md delete mode 100644 docs/list/playlist/playlisttrack/update/index.md diff --git a/docs/list/playlist/playlisttrack/destroy/index.md b/docs/list/playlist/playlisttrack/destroy/index.md deleted file mode 100644 index fafddbb..0000000 --- a/docs/list/playlist/playlisttrack/destroy/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Playlist Track Destroy ---- - -# Playlist Track Destroy Endpoint - -The playlist track destroy endpoint soft deletes a playlist track and returns the deleted playlist track resource. - -For example, the `/playlist/1/playlisttrack/1` endpoint will soft delete the playlist track of id `1` and return the deleted playlist track resource. - -## URL - -```sh -DELETE /playlist/{id}/playlisttrack/{id} -``` - -## Authentication - -**Required Permission**: delete playlist track - -**Other Requirements**: User must own playlist - -## Parameters - -None - -## Response - -```json -{ - playlisttrack: { - id: id, - 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/playlist/1/playlisttrack/1 -``` diff --git a/docs/list/playlist/playlisttrack/forceDelete/index.md b/docs/list/playlist/playlisttrack/forceDelete/index.md deleted file mode 100644 index a7489c1..0000000 --- a/docs/list/playlist/playlisttrack/forceDelete/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Playlist Track Force Delete ---- - -# Playlist Track Force Delete Endpoint - -The playlist track force delete endpoint hard deletes a playlist track and returns a confirmation message. - -For example, the `/forceDelete/playlist/1/playlisttrack/1` endpoint will hard delete the playlist track of id `1` and return a confirmation message. - -## URL - -```sh -DELETE /forceDelete/playlist/{id}/playlisttrack{id} -``` - -## Authentication - -**Required Permission**: force delete playlist - -**Roles with Permission**: Admin - -## Parameters - -None - -## Response - -```json -{ - message: "The Playlist Track '1' was deleted.", -} -``` - -## Example - -```bash -curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/forceDelete/playlist/1/playlisttrack/1 -``` \ No newline at end of file diff --git a/docs/list/playlist/playlisttrack/index.md b/docs/list/playlist/playlisttrack/index.md deleted file mode 100644 index 39fcfc2..0000000 --- a/docs/list/playlist/playlisttrack/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Playlist Track ---- - -# Playlist Track - ---- - -A playlist track API resource represents an entry in a playlist. - -For example, a "/r/anime's Best OPs and EDs of 2022" playlist may contain a track for the ParipiKoumei-OP1.webm video. - -### Fields - -| Name | Type | Nullable | Description | -| :--------: | :-----: | :------: | :------------------------------------------- | -| id | Integer | No | The primary key of the resource | -| 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 | - -### Allowed Include Paths - -* next -* playlist -* previous -* video - -### Endpoints - -**[Playlist Track Destroy](/playlisttrack/destroy/)** - -The playlist track destroy endpoint soft deletes a playlist track and returns the deleted playlist track resource. - -**[Playlist Track Force Delete](/playlisttrack/forceDelete/)** - -The playlist track force delete endpoint hard deletes a playlist track and returns a confirmation message. - -**[Playlist Track Index](/playlisttrack/index/)** - -The playlist track index endpoint displays a listing of playlist track resources. - -**[Playlist Track Show](/playlisttrack/show/)** - -The playlist track show endpoint returns a playlist track resource. - -**[Playlist Track Store](/playlisttrack/store/)** - -The playlist track store endpoint creates a new playlist track and returns the new playlist track resource. - -**[Playlist Track Update](/playlisttrack/update/)** - -The playlist track update endpoint updates a playlist track and returns the updated playlist track resource. \ No newline at end of file diff --git a/docs/list/playlist/playlisttrack/index/index.md b/docs/list/playlist/playlisttrack/index/index.md deleted file mode 100644 index c0dcddd..0000000 --- a/docs/list/playlist/playlisttrack/index/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: Playlist Index ---- - -# Playlist Index Endpoint - -The playlist index endpoint returns a listing of tracks for the playlist. - -## URL - -```sh -GET /playlist/{id}/playlisttrack -``` - -## Authentication - -**Required Permission**: view playlist track - -**Other Requirements**: If the playlist is private, the user must own the playlist - -## Parameters - -| Name | Required | Description | -| :----------: | :------: | :------------------------------------------------------------------------------- | -| fields | No | Sparse fieldsets for resource types | -| filter | No | Filters for playlist resources & constraining the inclusion of related resources | -| include | No | Inclusion of related resources | -| page[number] | No | The page of playlist resources to display | -| page[size] | No | The number of playlist resources to display for the current page | -| sort | No | The list of fields to sort the resources | - -## Allowed Sort Fields - -| Name | Description | -| :--------: | :------------------------------------------------------------------ | -| id | Sort resources on the primary key | -| 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 | -| 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 -{ - playlisttracks: [ - { - id: id, - 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/playlist/1/playlisttrack -``` \ No newline at end of file diff --git a/docs/list/playlist/playlisttrack/show/index.md b/docs/list/playlist/playlisttrack/show/index.md deleted file mode 100644 index 7b8c64b..0000000 --- a/docs/list/playlist/playlisttrack/show/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Playlist Track Show ---- - -# Playlist Track Show Endpoint - -The playlist track show endpoint returns a playlist track resource. - -## URL - -```sh -GET /playlist/{id}/playlisttrack/{id} -``` - -## Authentication - -**Required Permission**: view playlist track - -**Other Requirements**: If the playlist is private, the user must own the playlist - -## 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 -{ - playlisttrack: { - id: id, - created_at: "created_at", - updated_at: "updated_at", - deleted_at: "deleted_at" - } -} -``` - -## Example - -```bash -curl https://api.animethemes.moe/playlist/1/playlisttrack/1 -``` \ No newline at end of file diff --git a/docs/list/playlist/playlisttrack/store/index.md b/docs/list/playlist/playlisttrack/store/index.md deleted file mode 100644 index 19cd517..0000000 --- a/docs/list/playlist/playlisttrack/store/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Playlist Track Store ---- - -# Playlist Track Store Endpoint - -The playlist track store endpoint creates a new playlist track and returns the new playlist track resource. - -For example, the `/playlist/1/playlisttrack?video_id=2712` endpoint will create a new playlist track for the Bakemonogatari-OP1.webm video and return the new playlist track resource. - -## URL - -```sh -POST /playlist/{id}/playlisttrack -``` - -## Authentication - -**Required Permission**: create playlist track - -**Other Requirements**: The user must own the playlist - -## Parameters - -| Name | Required | Rules | -| :--------: | :------: | :-------------- | -| name | Yes | string, max:192 | -| video_id | Yes | Video ID Exists | - -## Response - -```json -{ - playlisttrack: { - id: id, - 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/playlist/1/playlisttrack -``` diff --git a/docs/list/playlist/playlisttrack/update/index.md b/docs/list/playlist/playlisttrack/update/index.md deleted file mode 100644 index a0f6f74..0000000 --- a/docs/list/playlist/playlisttrack/update/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Playlist Track Update ---- - -# Playlist Track Update Endpoint - -The playlist track update endpoint updates a playlist track and returns the updated playlist track resource. - -For example, the `/playlist/1/playlisttrack/1?next_id=2` endpoint will update the playlist track of id `1` next_id attribute and return the updated playlist track resource. - -## URL - -```sh -PUT|PATCH /playlist/{id}/playlisttrack/{id} -``` - -## Authentication - -**Required Permission**: update playlist track - -**Other Requirements**: User must own playlist - -## Parameters - -| Name | Required | Rules | -| :---------: | :------: | :------------------------------------------ | -| next_id | No | Track ID exists & Track Playlist ID matches | -| previous_id | No | Track ID exists & Track Playlist ID matches | -| video_id | No | Video ID Exists | - -## Response - -```json -{ - playlisttrack: { - id: id, - 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/playlist/1/playlisttrack/1 -``` \ No newline at end of file