From 28e734f66111de3496d64a6a5c70d1f1b8c7e25b Mon Sep 17 00:00:00 2001 From: Kyrch Date: Thu, 9 Apr 2026 07:46:27 -0300 Subject: [PATCH] docs: remove artistsong endpoints (#129) --- docs/.vitepress/config.js | 7 +- .../content/artistsong/destroy/index.md | 39 --------- .../reference/content/artistsong/index.md | 39 +++------ .../content/artistsong/index/index.md | 82 ------------------- .../content/artistsong/show/index.md | 42 ---------- .../content/artistsong/store/index.md | 47 ----------- .../content/artistsong/update/index.md | 47 ----------- 7 files changed, 11 insertions(+), 292 deletions(-) delete mode 100644 docs/jsonapi/reference/content/artistsong/destroy/index.md delete mode 100644 docs/jsonapi/reference/content/artistsong/index/index.md delete mode 100644 docs/jsonapi/reference/content/artistsong/show/index.md delete mode 100644 docs/jsonapi/reference/content/artistsong/store/index.md delete mode 100644 docs/jsonapi/reference/content/artistsong/update/index.md diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index ecfece7..3876230 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -155,12 +155,7 @@ const referenceSidebarItems = [ text: 'Artist Song', collapsed: true, items: [ - { text: 'Resource', link: '/content/artistsong/' }, - { text: 'Destroy', link: '/content/artistsong/destroy/' }, - { text: 'Index', link: '/content/artistsong/index/' }, - { text: 'Show', link: '/content/artistsong/show/' }, - { text: 'Store', link: '/content/artistsong/store/' }, - { text: 'Update', link: '/content/artistsong/update/' } + { text: 'Resource', link: '/content/artistsong/' } ] }, { diff --git a/docs/jsonapi/reference/content/artistsong/destroy/index.md b/docs/jsonapi/reference/content/artistsong/destroy/index.md deleted file mode 100644 index d55bd8f..0000000 --- a/docs/jsonapi/reference/content/artistsong/destroy/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Artist Song Destroy ---- - -# Artist Song Destroy Endpoint - -The artist song destroy endpoint deletes an artist song and returns the deleted artist song resource. - -For example, the `/artistsong/chiwa_saitou/3373` endpoint will delete the association between the Chiwa Saitou artist and the "staple stable" song. - -## URL - -```sh -DELETE /artistsong/{artist:slug}/{song:id} -``` - -## Authentication - -**Required Permission**: delete artist, delete song - -**Roles with Permission**: Content Moderator, Encoder, Admin - -## Parameters - -None - -## Response - -```json -{ - message: "Song 'staple stable' has been detached from Artist 'Chiwa Saitou'.", -} -``` - -## Example - -```bash -curl -X DELETE -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistsong/chiwa_saitou/3373 -``` diff --git a/docs/jsonapi/reference/content/artistsong/index.md b/docs/jsonapi/reference/content/artistsong/index.md index 32f3919..653945c 100644 --- a/docs/jsonapi/reference/content/artistsong/index.md +++ b/docs/jsonapi/reference/content/artistsong/index.md @@ -10,36 +10,17 @@ An artist song API resource represents the association between an artist and an ## Fields -| Name | Type | Nullable | Default | Description | -| :--------: | :-----: | :------: | :-----: | :------------------------------------------------------------- | -| 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 | -| alias | String | Yes | Yes | Used to distinguish a performance by alias | -| as | String | Yes | Yes | Used to distinguish a performance by character | +| Name | Type | Nullable | Default | Description | +| :----------: | :-----: | :------: | :-----: | :---------------------------------------------------- | +| 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 | +| alias | String | Yes | Yes | Used to distinguish a performance by alias | +| as | String | Yes | Yes | Used to distinguish a performance by character | +| member_alias | String | Yes | Yes | Used to distinguish a member performance by alias | +| member_as | String | Yes | Yes | Used to distinguish a member performance by character | +| relevance | Int | No | Yes | Used to sort the song performances by its relevance | ## Allowed Include Paths * artist -* song - -## Endpoints - -**[Artist Song Destroy](/content/artistsong/destroy/)** - -The artist song destroy endpoint deletes an artist song and returns the deleted artist song resource. - -**[Artist Song Index](/content/artistsong/index/)** - -The artist song index endpoint displays a listing of artist song resources. - -**[Artist Song Show](/content/artistsong/show/)** - -The artist song show endpoint returns an artist song resource. - -**[Artist Song Store](/content/artistsong/store/)** - -The artist song store endpoint creates a new artist song and returns the new artist song resource. - -**[Artist Song Update](/content/artistsong/update/)** - -The artist song update endpoint updates an artist song and returns the updated artist song resource. \ No newline at end of file +* song \ No newline at end of file diff --git a/docs/jsonapi/reference/content/artistsong/index/index.md b/docs/jsonapi/reference/content/artistsong/index/index.md deleted file mode 100644 index c56ccd6..0000000 --- a/docs/jsonapi/reference/content/artistsong/index/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: Artist Song Index ---- - -# Artist Song Index Endpoint - -The artist song index endpoint returns a listing of artist song resources. - -## URL - -```sh -GET /artistsong/ -``` - -## Authentication - -None - -## Parameters - -| Name | Required | Description | -| :----------: | :------: | :---------------------------------------------------------------------------------- | -| fields | No | Sparse fieldsets for resource types | -| filter | No | Filters for artist song resources & constraining the inclusion of related resources | -| include | No | Inclusion of related resources | -| page[number] | No | The page of artist song resources to display | -| page[size] | No | The number of artist song resources to display for the current page | -| sort | No | The list of fields to sort the resources | - -## Allowed Sort Fields - -| Name | Description | -| :--------: | :---------------------------------------------------------------------------------- | -| created_at | Sort resources on the resource creation date | -| updated_at | Sort resources on the resource last modified date | -| alias | Sort resources on distinguishing label for performance by alias | -| as | Sort resources on distinguishing label for performance by character | - -## Filters - -| Name | Description | -| :--------: | :------------------------------------------------------------------------------------ | -| created_at | Filter resources on the resource creation date | -| updated_at | Filter resources on the resource last modified date | -| has | Filter resources on relations within allowed include paths | -| alias | Filter resources on distinguishing label for performance by alias | -| as | Filter resources on distinguishing label for performance by character | - -## Response - -```json -{ - artistsongs: [ - { - created_at: "created_at", - updated_at: "updated_at", - alias: "alias", - as: "as" - }, - ... - ], - 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/artistsong/ -``` diff --git a/docs/jsonapi/reference/content/artistsong/show/index.md b/docs/jsonapi/reference/content/artistsong/show/index.md deleted file mode 100644 index da2fb00..0000000 --- a/docs/jsonapi/reference/content/artistsong/show/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Artist Song Show ---- - -# Artist Song Show Endpoint - -The artist song show endpoint returns an artist song resource. - -For example, the `/artistsong/chiwa_saitou/3373` endpoint will return the artist song resource for the association between the Chiwa Saitou artist and the "staple stable" song. - -## URL - -```sh -GET /artistsong/{artist:slug}/{song:id} -``` - -## Authentication - -None - -## Parameters - -None - -## Response - -```json -{ - artistsong: { - created_at: "created_at", - updated_at: "updated_at", - alias: "alias", - as: "as" - } -} -``` - -## Example - -```bash -curl https://api.animethemes.moe/artistsong/chiwa_saitou/3373 -``` diff --git a/docs/jsonapi/reference/content/artistsong/store/index.md b/docs/jsonapi/reference/content/artistsong/store/index.md deleted file mode 100644 index 12dbf5f..0000000 --- a/docs/jsonapi/reference/content/artistsong/store/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Artist Song Store ---- - -# Artist Song Store Endpoint - -The artist song store endpoint creates a new artist song and returns the new artist song resource. - -For example, the `/artistsong/chiwa_saitou/3373` endpoint will create a new association between the Chiwa Saitou artist and the "staple stable" song. - -## URL - -```sh -POST /artistsong/{artist:slug}/{song:id} -``` - -## Authentication - -**Required Permission**: create artist, create song - -**Roles with Permission**: Content Moderator, Encoder, Admin - -## Parameters - -| Name | Required | Rules | -| :---: | :------: | :-------------- | -| alias | No | string, max:192 | -| as | No | string, max:192 | - -## Response - -```json -{ - artistsong: { - created_at: "created_at", - updated_at: "updated_at", - alias: "alias", - as: "as" - } -} -``` - -## Example - -```bash -curl -X POST -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistsong/chiwa_saitou/3373 -``` diff --git a/docs/jsonapi/reference/content/artistsong/update/index.md b/docs/jsonapi/reference/content/artistsong/update/index.md deleted file mode 100644 index fac1199..0000000 --- a/docs/jsonapi/reference/content/artistsong/update/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Artist Song Update ---- - -# Artist Song Update Endpoint - -The artist song update endpoint updates an artist song and returns the updated artist song resource. - -For example, the `/artistsong/chiwa_saitou/3373?as=updated+label` endpoint will update the association between the Chiwa Saitou artist and the "staple stable" song. - -## URL - -```sh -PUT|PATCH /artistsong/{artist:slug}/{song:id} -``` - -## Authentication - -**Required Permission**: update artist, update song - -**Roles with Permission**: Content Moderator, Encoder, Admin - -## Parameters - -| Name | Required | Rules | -| :---------: | :------: | :-------------- | -| alias | No | string, max:192 | -| as | No | string, max:192 | - -## Response - -```json -{ - artistsong: { - created_at: "created_at", - updated_at: "updated_at", - alias: "alias", - as: "as" - } -} -``` - -## Example - -```bash -curl -X PATCH -H "Authorization: Bearer {token}" https://api.animethemes.moe/artistsong/ -```