From a3e6dfb23b0345bc2aa8e51c2e80763169c75932 Mon Sep 17 00:00:00 2001 From: Kyrch Date: Thu, 3 Oct 2024 23:21:41 -0300 Subject: [PATCH] feat: added alias field to artist pivots (#104) --- docs/wiki/artistmember/index.md | 3 ++- docs/wiki/artistmember/index/index.md | 7 +++++-- docs/wiki/artistmember/show/index.md | 1 + docs/wiki/artistmember/store/index.md | 8 +++++--- docs/wiki/artistmember/update/index.md | 2 ++ docs/wiki/artistsong/index.md | 3 ++- docs/wiki/artistsong/index/index.md | 7 +++++-- docs/wiki/artistsong/show/index.md | 1 + docs/wiki/artistsong/store/index.md | 8 +++++--- docs/wiki/artistsong/update/index.md | 2 ++ 10 files changed, 30 insertions(+), 12 deletions(-) diff --git a/docs/wiki/artistmember/index.md b/docs/wiki/artistmember/index.md index 8704e7e..8c4c368 100644 --- a/docs/wiki/artistmember/index.md +++ b/docs/wiki/artistmember/index.md @@ -14,7 +14,8 @@ An artist member API resource represents the association of an artist and a grou | :--------: | :-----: | :------: | :-----: | :--------------------------------------------------- | | 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 | -| as | String | No | Yes | Used to distinguish membership by alias or character | +| alias | String | Yes | Yes | Used to distinguish membership by alias | +| as | String | Yes | Yes | Used to distinguish membership by character | ## Allowed Include Paths diff --git a/docs/wiki/artistmember/index/index.md b/docs/wiki/artistmember/index/index.md index 65cef00..2215572 100644 --- a/docs/wiki/artistmember/index/index.md +++ b/docs/wiki/artistmember/index/index.md @@ -33,7 +33,8 @@ None | :--------: | :------------------------------------------------------------ | | created_at | Sort resources on the resource creation date | | updated_at | Sort resources on the resource last modified date | -| as | Sort resources on distinguishing label for alias or character | +| alias | Sort resources on distinguishing label for alias | +| as | Sort resources on distinguishing label for character | ## Filters @@ -42,7 +43,8 @@ None | 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 | -| as | Filter resources on distinguishing label for alias or character | +| alias | Filter resources on distinguishing label for alias | +| as | Filter resources on distinguishing label for character | ## Response @@ -52,6 +54,7 @@ None { created_at: "created_at", updated_at: "updated_at", + alias: "alias", as: "as" }, ... diff --git a/docs/wiki/artistmember/show/index.md b/docs/wiki/artistmember/show/index.md index e9027b0..5664e54 100644 --- a/docs/wiki/artistmember/show/index.md +++ b/docs/wiki/artistmember/show/index.md @@ -29,6 +29,7 @@ None artistmember: { created_at: "created_at", updated_at: "updated_at", + alias: "alias", as: "as" } } diff --git a/docs/wiki/artistmember/store/index.md b/docs/wiki/artistmember/store/index.md index 5950736..dd9b1b7 100644 --- a/docs/wiki/artistmember/store/index.md +++ b/docs/wiki/artistmember/store/index.md @@ -22,9 +22,10 @@ POST /artistmember/{artist:slug}/{artist:slug} ## Parameters -| Name | Required | Rules | -| :--: | :------: | :-------------- | -| as | No | string, max:192 | +| Name | Required | Rules | +| :---: | :------: | :-------------- | +| alias | No | string, max:192 | +| as | No | string, max:192 | ## Response @@ -33,6 +34,7 @@ POST /artistmember/{artist:slug}/{artist:slug} artistmember: { created_at: "created_at", updated_at: "updated_at", + alias: "alias", as: "as" } } diff --git a/docs/wiki/artistmember/update/index.md b/docs/wiki/artistmember/update/index.md index 77cf86f..bb01abe 100644 --- a/docs/wiki/artistmember/update/index.md +++ b/docs/wiki/artistmember/update/index.md @@ -24,6 +24,7 @@ PUT|PATCH /artistmember/{artist:slug}/{artist:slug} | Name | Required | Rules | | :---------: | :------: | :-------------- | +| alias | No | string, max:192 | | as | No | string, max:192 | ## Response @@ -33,6 +34,7 @@ PUT|PATCH /artistmember/{artist:slug}/{artist:slug} artistmember: { created_at: "created_at", updated_at: "updated_at", + alias: "alias", as: "as" } } diff --git a/docs/wiki/artistsong/index.md b/docs/wiki/artistsong/index.md index 2336803..97913c0 100644 --- a/docs/wiki/artistsong/index.md +++ b/docs/wiki/artistsong/index.md @@ -14,7 +14,8 @@ An artist song API resource represents the association between an artist and an | :--------: | :-----: | :------: | :-----: | :------------------------------------------------------------- | | 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 | -| as | String | No | Yes | Used to distinguish a performance by alias, character or group | +| as | String | Yes | Yes | Used to distinguish a performance by alias | +| as | String | Yes | Yes | Used to distinguish a performance by character | ## Allowed Include Paths diff --git a/docs/wiki/artistsong/index/index.md b/docs/wiki/artistsong/index/index.md index d0bb0a3..c56ccd6 100644 --- a/docs/wiki/artistsong/index/index.md +++ b/docs/wiki/artistsong/index/index.md @@ -33,7 +33,8 @@ None | :--------: | :---------------------------------------------------------------------------------- | | created_at | Sort resources on the resource creation date | | updated_at | Sort resources on the resource last modified date | -| as | Sort resources on distinguishing label for performance by alias, character or group | +| alias | Sort resources on distinguishing label for performance by alias | +| as | Sort resources on distinguishing label for performance by character | ## Filters @@ -42,7 +43,8 @@ None | 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 | -| as | Filter resources on distinguishing label for performance by alias, character or group | +| alias | Filter resources on distinguishing label for performance by alias | +| as | Filter resources on distinguishing label for performance by character | ## Response @@ -52,6 +54,7 @@ None { created_at: "created_at", updated_at: "updated_at", + alias: "alias", as: "as" }, ... diff --git a/docs/wiki/artistsong/show/index.md b/docs/wiki/artistsong/show/index.md index 2ab0cd2..da2fb00 100644 --- a/docs/wiki/artistsong/show/index.md +++ b/docs/wiki/artistsong/show/index.md @@ -29,6 +29,7 @@ None artistsong: { created_at: "created_at", updated_at: "updated_at", + alias: "alias", as: "as" } } diff --git a/docs/wiki/artistsong/store/index.md b/docs/wiki/artistsong/store/index.md index 09434f8..22faa51 100644 --- a/docs/wiki/artistsong/store/index.md +++ b/docs/wiki/artistsong/store/index.md @@ -22,9 +22,10 @@ POST /artistsong/{artist:slug}/{song:id} ## Parameters -| Name | Required | Rules | -| :--: | :------: | :-------------- | -| as | No | string, max:192 | +| Name | Required | Rules | +| :---: | :------: | :-------------- | +| alias | No | string, max:192 | +| as | No | string, max:192 | ## Response @@ -33,6 +34,7 @@ POST /artistsong/{artist:slug}/{song:id} artistsong: { created_at: "created_at", updated_at: "updated_at", + alias: "alias", as: "as" } } diff --git a/docs/wiki/artistsong/update/index.md b/docs/wiki/artistsong/update/index.md index 2b9ef16..346fc63 100644 --- a/docs/wiki/artistsong/update/index.md +++ b/docs/wiki/artistsong/update/index.md @@ -24,6 +24,7 @@ PUT|PATCH /artistsong/{artist:slug}/{song:id} | Name | Required | Rules | | :---------: | :------: | :-------------- | +| alias | No | string, max:192 | | as | No | string, max:192 | ## Response @@ -33,6 +34,7 @@ PUT|PATCH /artistsong/{artist:slug}/{song:id} artistsong: { created_at: "created_at", updated_at: "updated_at", + alias: "alias", as: "as" } }