malhuda/jikan-rest
1
0
Fork 0
mirror of https://github.com/jikan-me/jikan-rest.git synced 2025-02-20 11:23:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update

Browse Source
This commit is contained in:
Irfan 2022-07-27 21:59:58 +05:00
parent 78d0759611
commit 79a8a12597
2 changed files with 108 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
app/Http/Controllers/V4DB/AnimeController.php
View File

@ -731,7 +731,7 @@ class AnimeController extends Controller
*
* @OA\Response(
* response="200",
* description="Returns videos related to the entry",
* description="Returns episode videos related to the entry",
* @OA\JsonContent(
* ref="#/components/schemas/anime_videos_episodes"
* )
@ -740,6 +740,7 @@ class AnimeController extends Controller
* response="400",
* description="Error: Bad request. When required parameters were not supplied.",
* ),
* ),
*
*
* @OA\Schema(
@ -749,41 +750,40 @@ class AnimeController extends Controller
* allOf={
* @OA\Schema(ref="#/components/schemas/pagination"),
* @OA\Schema(
* @OA\Property(
* property="data",
* type="array",
* @OA\Items(
* type="object",
* @OA\Property(
* property="mal_id",
* type="integer",
* description="MyAnimeList ID or Episode Number"
* ),
* @OA\Property(
* property="title",
* type="string",
* description="Episode Title"
* ),
* @OA\Property(
* property="episode",
* type="string",
* description="Episode Subtitle"
* ),
* @OA\Property(
* property="url",
* type="string",
* description="Episode Page URL",
* ),
* @OA\Property(
* property="images",
* ref="#/components/schemas/common_images"
* ),
* @OA\Property(
* property="data",
* type="array",
* @OA\Items(
* type="object",
* @OA\Property(
* property="mal_id",
* type="integer",
* description="MyAnimeList ID or Episode Number"
* ),
* @OA\Property(
* property="title",
* type="string",
* description="Episode Title"
* ),
* @OA\Property(
* property="episode",
* type="string",
* description="Episode Subtitle"
* ),
* @OA\Property(
* property="url",
* type="string",
* description="Episode Page URL",
* ),
* @OA\Property(
* property="images",
* ref="#/components/schemas/common_images"
* ),
* ),
* ),
* ),
* ),
* }
* )
* )
*/
public function videosEpisodes(Request $request, int $id)
{
@ -791,7 +791,6 @@ class AnimeController extends Controller
->where('request_hash', $this->fingerprint)
->get();
if (
$results->isEmpty()
|| $this->isExpired($request, $results)

76
storage/api-docs/api-docs.json
View File

@ -361,6 +361,42 @@
}
}
},
"/anime/{id}/videos/episodes": {
"get": {
"tags": [
"anime"
],
"operationId": "getAnimeVideosEpisodes",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"$ref": "#/components/parameters/page"
}
],
"responses": {
"200": {
"description": "Returns episode videos related to the entry",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/anime_videos_episodes"
}
}
}
},
"400": {
"description": "Error: Bad request. When required parameters were not supplied."
}
}
}
},
"/anime/{id}/pictures": {
"get": {
"tags": [
@ -3914,6 +3950,46 @@
}
]
},
"anime_videos_episodes": {
"description": "Anime Videos Episodes Resource",
"allOf": [
{
"properties": {
"data": {
"type": "array",
"items": {
"properties": {
"mal_id": {
"description": "MyAnimeList ID or Episode Number",
"type": "integer"
},
"title": {
"description": "Episode Title",
"type": "string"
},
"episode": {
"description": "Episode Subtitle",
"type": "string"
},
"url": {
"description": "Episode Page URL",
"type": "string"
},
"images": {
"$ref": "#/components/schemas/common_images"
}
},
"type": "object"
}
}
},
"type": "object"
},
{
"$ref": "#/components/schemas/pagination"
}
]
},
"character_pictures": {
"description": "Character Pictures",
"properties": {