diff --git a/docs/wiki/anime/destroy/index.md b/docs/wiki/anime/destroy/index.md index 3e0953a..37003d5 100644 --- a/docs/wiki/anime/destroy/index.md +++ b/docs/wiki/anime/destroy/index.md @@ -36,6 +36,7 @@ None slug: "slug", year: year, season: "season", + media_format: "media_format", synopsis: "synopsis", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/wiki/anime/index.md b/docs/wiki/anime/index.md index 28f8efb..5edfd70 100644 --- a/docs/wiki/anime/index.md +++ b/docs/wiki/anime/index.md @@ -12,17 +12,18 @@ For example, Bakemonogatari is an anime production with five opening sequences a ## Fields -| Name | Type | Nullable | Default | Description | -| :--------: | :-----: | :------: | :-----: | :-------------------------------------------------------------- | -| id | Integer | No | Yes | The primary key of the resource | -| name | String | No | Yes | The primary title of the anime | -| slug | String | No | Yes | The URL slug & route key of the resource | -| year | Integer | Yes | Yes | The premiere year of the anime | -| season | Enum | Yes | Yes | The premiere season of the anime [Winter, Spring, Summer, Fall] | -| synopsis | String | Yes | Yes | The brief summary of the anime | -| 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 | -| deleted_at | Date | Yes | No | The date that the resource was deleted | +| Name | Type | Nullable | Description | +| :--------: | :-----: | :------: | :------------------------------------------------------------------------------ | +| id | Integer | No | The primary key of the resource | +| name | String | No | The primary title of the anime | +| slug | String | No | The URL slug & route key of the resource | +| year | Integer | Yes | The premiere year of the anime | +| season | Enum | Yes | The premiere season of the anime [Winter, Spring, Summer, Fall] | +| media_format | Enum | Yes | The media format of the anime [Unknown, TV, TV Short, OVA, Movie, Special, ONA] | +| synopsis | String | Yes | The brief summary of the anime | +| 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 diff --git a/docs/wiki/anime/index/index.md b/docs/wiki/anime/index/index.md index 9ddce3f..364832d 100644 --- a/docs/wiki/anime/index/index.md +++ b/docs/wiki/anime/index/index.md @@ -30,34 +30,36 @@ None ## Allowed Sort Fields -| Name | Description | -| :--------: | :------------------------------------------------------------------ | -| id | Sort resources on the primary key | -| name | Sort resources on the title of the anime | -| slug | Sort resources on the URL slug of the anime | -| year | Sort resources on the premiere year of the anime | -| season | Sort resources on the premiere season of the anime | -| synopsis | Sort resources on the brief summary of the anime | -| 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. | +| Name | Description | +| :----------: | :------------------------------------------------------------------ | +| id | Sort resources on the primary key | +| name | Sort resources on the title of the anime | +| slug | Sort resources on the URL slug of the anime | +| year | Sort resources on the premiere year of the anime | +| season | Sort resources on the premiere season of the anime | +| media_format | Sort resources on the media format of the anime | +| synopsis | Sort resources on the brief summary of the anime | +| 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 | -| name | Filter resources on the title of the anime | -| slug | Filter resources on the URL slug of the anime | -| year | Filter resources on the premiere year of the anime | -| season | Filter resources on the premiere season of the anime | -| synopsis | Filter resources on the brief summary of the anime | -| 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 | +| Name | Description | +| :----------: | :----------------------------------------------------------------- | +| id | Filter resources on the primary key | +| name | Filter resources on the title of the anime | +| slug | Filter resources on the URL slug of the anime | +| year | Filter resources on the premiere year of the anime | +| season | Filter resources on the premiere season of the anime | +| media_format | Filter resources on the media format of the anime | +| synopsis | Filter resources on the brief summary of the anime | +| 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 @@ -70,6 +72,7 @@ None slug: "slug", year: year, season: "season", + media_format: "media_format", synopsis: "synopsis", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/wiki/anime/restore/index.md b/docs/wiki/anime/restore/index.md index 68a83ce..0a27a2a 100644 --- a/docs/wiki/anime/restore/index.md +++ b/docs/wiki/anime/restore/index.md @@ -36,6 +36,7 @@ None slug: "slug", year: year, season: "season", + media_format: "media_format", synopsis: "synopsis", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/wiki/anime/show/index.md b/docs/wiki/anime/show/index.md index a342beb..0785ddd 100644 --- a/docs/wiki/anime/show/index.md +++ b/docs/wiki/anime/show/index.md @@ -37,6 +37,7 @@ None slug: "slug", year: year, season: "season", + media_format: "media_format", synopsis: "synopsis", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/wiki/anime/store/index.md b/docs/wiki/anime/store/index.md index 69b0f6b..295e005 100644 --- a/docs/wiki/anime/store/index.md +++ b/docs/wiki/anime/store/index.md @@ -6,7 +6,7 @@ title: Anime Store The anime store endpoint creates a new anime and returns the new anime resource. -For example, the `/anime?name=Bakemonogatari&slug=bakemonogatari&year=2009&season=summer` endpoint will create a new Bakemonogatari anime and return the new Bakemonogatari resource. +For example, the `/anime?name=Bakemonogatari&slug=bakemonogatari&year=2009&season=summer&media_format=tv` endpoint will create a new Bakemonogatari anime and return the new Bakemonogatari resource. ## URL @@ -22,13 +22,14 @@ POST /anime ## Parameters -| Name | Required | Rules | -| :------: | :------: | :----------------------------------------------------- | -| name | Yes | string, max:192 | -| season | Yes | EnumValue [Winter, Spring, Summer, Fall] | -| slug | Yes | string, max:192, alpha_dash, unique | -| synopsis | No | string, max:65535 | -| year | Yes | integer, digits:4, min:1960, max:[current year + 1] | +| Name | Required | Rules | +| :----------: | :------: | :---------------------------------------------------------- | +| name | Yes | string, max:192 | +| season | Yes | EnumValue [Winter, Spring, Summer, Fall] | +| media_format | Yes | EnumValue [Unknown, TV, TV Short, OVA, Movie, Special, ONA] | +| slug | Yes | string, max:192, alpha_dash, unique | +| synopsis | No | string, max:65535 | +| year | Yes | integer, digits:4, min:1960, max:[current year + 1] | ## Response @@ -40,6 +41,7 @@ POST /anime slug: "slug", year: year, season: "season", + media_format: "media_format", synopsis: "synopsis", created_at: "created_at", updated_at: "updated_at", diff --git a/docs/wiki/anime/update/index.md b/docs/wiki/anime/update/index.md index eca11f8..c161c22 100644 --- a/docs/wiki/anime/update/index.md +++ b/docs/wiki/anime/update/index.md @@ -24,13 +24,14 @@ PUT|PATCH /anime/{slug} ## Parameters -| Name | Required | Rules | -| :------: | :------: | :----------------------------------------------------- | -| name | No | string, max:192 | -| season | No | EnumValue [Winter, Spring, Summer, Fall] | -| slug | No | string, max:192, alpha_dash, unique | -| synopsis | No | string, max:65535 | -| year | No | integer, digits:4, min:1960, max:[current year + 1] | +| Name | Required | Rules | +| :----------: | :------: | :---------------------------------------------------------- | +| name | No | string, max:192 | +| season | No | EnumValue [Winter, Spring, Summer, Fall] | +| media_format | No | EnumValue [Unknown, TV, TV Short, OVA, Movie, Special, ONA] | +| slug | No | string, max:192, alpha_dash, unique | +| synopsis | No | string, max:65535 | +| year | No | integer, digits:4, min:1960, max:[current year + 1] | ## Response @@ -42,6 +43,7 @@ PUT|PATCH /anime/{slug} slug: "slug", year: year, season: "season", + media_format: "media_format", synopsis: "synopsis", created_at: "created_at", updated_at: "updated_at",