feat: added alias field to artist pivots (#104)

This commit is contained in:
Kyrch
2024-10-03 23:21:41 -03:00
committed by GitHub
parent c6e33c1d5b
commit a3e6dfb23b
10 changed files with 30 additions and 12 deletions
+2 -1
View File
@@ -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
+5 -2
View File
@@ -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"
},
...
+1
View File
@@ -29,6 +29,7 @@ None
artistmember: {
created_at: "created_at",
updated_at: "updated_at",
alias: "alias",
as: "as"
}
}
+5 -3
View File
@@ -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"
}
}
+2
View File
@@ -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"
}
}
+2 -1
View File
@@ -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
+5 -2
View File
@@ -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"
},
...
+1
View File
@@ -29,6 +29,7 @@ None
artistsong: {
created_at: "created_at",
updated_at: "updated_at",
alias: "alias",
as: "as"
}
}
+5 -3
View File
@@ -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"
}
}
+2
View File
@@ -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"
}
}