mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-07-11 01:34:06 +02:00
feat: added alias field to artist pivots (#104)
This commit is contained in:
@@ -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 |
|
| 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 |
|
| 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
|
## Allowed Include Paths
|
||||||
|
|
||||||
|
|||||||
@@ -33,7 +33,8 @@ None
|
|||||||
| :--------: | :------------------------------------------------------------ |
|
| :--------: | :------------------------------------------------------------ |
|
||||||
| created_at | Sort resources on the resource creation date |
|
| created_at | Sort resources on the resource creation date |
|
||||||
| updated_at | Sort resources on the resource last modified 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
|
## Filters
|
||||||
|
|
||||||
@@ -42,7 +43,8 @@ None
|
|||||||
| created_at | Filter resources on the resource creation date |
|
| created_at | Filter resources on the resource creation date |
|
||||||
| updated_at | Filter resources on the resource last modified date |
|
| updated_at | Filter resources on the resource last modified date |
|
||||||
| has | Filter resources on relations within allowed include paths |
|
| 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
|
## Response
|
||||||
|
|
||||||
@@ -52,6 +54,7 @@ None
|
|||||||
{
|
{
|
||||||
created_at: "created_at",
|
created_at: "created_at",
|
||||||
updated_at: "updated_at",
|
updated_at: "updated_at",
|
||||||
|
alias: "alias",
|
||||||
as: "as"
|
as: "as"
|
||||||
},
|
},
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ None
|
|||||||
artistmember: {
|
artistmember: {
|
||||||
created_at: "created_at",
|
created_at: "created_at",
|
||||||
updated_at: "updated_at",
|
updated_at: "updated_at",
|
||||||
|
alias: "alias",
|
||||||
as: "as"
|
as: "as"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -22,9 +22,10 @@ POST /artistmember/{artist:slug}/{artist:slug}
|
|||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
| Name | Required | Rules |
|
| Name | Required | Rules |
|
||||||
| :--: | :------: | :-------------- |
|
| :---: | :------: | :-------------- |
|
||||||
| as | No | string, max:192 |
|
| alias | No | string, max:192 |
|
||||||
|
| as | No | string, max:192 |
|
||||||
|
|
||||||
## Response
|
## Response
|
||||||
|
|
||||||
@@ -33,6 +34,7 @@ POST /artistmember/{artist:slug}/{artist:slug}
|
|||||||
artistmember: {
|
artistmember: {
|
||||||
created_at: "created_at",
|
created_at: "created_at",
|
||||||
updated_at: "updated_at",
|
updated_at: "updated_at",
|
||||||
|
alias: "alias",
|
||||||
as: "as"
|
as: "as"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ PUT|PATCH /artistmember/{artist:slug}/{artist:slug}
|
|||||||
|
|
||||||
| Name | Required | Rules |
|
| Name | Required | Rules |
|
||||||
| :---------: | :------: | :-------------- |
|
| :---------: | :------: | :-------------- |
|
||||||
|
| alias | No | string, max:192 |
|
||||||
| as | No | string, max:192 |
|
| as | No | string, max:192 |
|
||||||
|
|
||||||
## Response
|
## Response
|
||||||
@@ -33,6 +34,7 @@ PUT|PATCH /artistmember/{artist:slug}/{artist:slug}
|
|||||||
artistmember: {
|
artistmember: {
|
||||||
created_at: "created_at",
|
created_at: "created_at",
|
||||||
updated_at: "updated_at",
|
updated_at: "updated_at",
|
||||||
|
alias: "alias",
|
||||||
as: "as"
|
as: "as"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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 |
|
| 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 |
|
| 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
|
## Allowed Include Paths
|
||||||
|
|
||||||
|
|||||||
@@ -33,7 +33,8 @@ None
|
|||||||
| :--------: | :---------------------------------------------------------------------------------- |
|
| :--------: | :---------------------------------------------------------------------------------- |
|
||||||
| created_at | Sort resources on the resource creation date |
|
| created_at | Sort resources on the resource creation date |
|
||||||
| updated_at | Sort resources on the resource last modified 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
|
## Filters
|
||||||
|
|
||||||
@@ -42,7 +43,8 @@ None
|
|||||||
| created_at | Filter resources on the resource creation date |
|
| created_at | Filter resources on the resource creation date |
|
||||||
| updated_at | Filter resources on the resource last modified date |
|
| updated_at | Filter resources on the resource last modified date |
|
||||||
| has | Filter resources on relations within allowed include paths |
|
| 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
|
## Response
|
||||||
|
|
||||||
@@ -52,6 +54,7 @@ None
|
|||||||
{
|
{
|
||||||
created_at: "created_at",
|
created_at: "created_at",
|
||||||
updated_at: "updated_at",
|
updated_at: "updated_at",
|
||||||
|
alias: "alias",
|
||||||
as: "as"
|
as: "as"
|
||||||
},
|
},
|
||||||
...
|
...
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ None
|
|||||||
artistsong: {
|
artistsong: {
|
||||||
created_at: "created_at",
|
created_at: "created_at",
|
||||||
updated_at: "updated_at",
|
updated_at: "updated_at",
|
||||||
|
alias: "alias",
|
||||||
as: "as"
|
as: "as"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -22,9 +22,10 @@ POST /artistsong/{artist:slug}/{song:id}
|
|||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
| Name | Required | Rules |
|
| Name | Required | Rules |
|
||||||
| :--: | :------: | :-------------- |
|
| :---: | :------: | :-------------- |
|
||||||
| as | No | string, max:192 |
|
| alias | No | string, max:192 |
|
||||||
|
| as | No | string, max:192 |
|
||||||
|
|
||||||
## Response
|
## Response
|
||||||
|
|
||||||
@@ -33,6 +34,7 @@ POST /artistsong/{artist:slug}/{song:id}
|
|||||||
artistsong: {
|
artistsong: {
|
||||||
created_at: "created_at",
|
created_at: "created_at",
|
||||||
updated_at: "updated_at",
|
updated_at: "updated_at",
|
||||||
|
alias: "alias",
|
||||||
as: "as"
|
as: "as"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ PUT|PATCH /artistsong/{artist:slug}/{song:id}
|
|||||||
|
|
||||||
| Name | Required | Rules |
|
| Name | Required | Rules |
|
||||||
| :---------: | :------: | :-------------- |
|
| :---------: | :------: | :-------------- |
|
||||||
|
| alias | No | string, max:192 |
|
||||||
| as | No | string, max:192 |
|
| as | No | string, max:192 |
|
||||||
|
|
||||||
## Response
|
## Response
|
||||||
@@ -33,6 +34,7 @@ PUT|PATCH /artistsong/{artist:slug}/{song:id}
|
|||||||
artistsong: {
|
artistsong: {
|
||||||
created_at: "created_at",
|
created_at: "created_at",
|
||||||
updated_at: "updated_at",
|
updated_at: "updated_at",
|
||||||
|
alias: "alias",
|
||||||
as: "as"
|
as: "as"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user