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-10-26 03:04:43 +05:00
parent fafdd42ef5
commit d1a08e2c17
3 changed files with 273 additions and 168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
app/Http/Controllers/V4DB/SearchController.php
View File

@ -641,6 +641,14 @@ class SearchController extends ControllerWithQueryBuilderProvider
} }
/** /**
*
* @OA\Schema(
* schema="producers_query_orderby",
* description="Producers Search Query Order By",
* type="string",
* enum={"mal_id", "count", "favorites", "established"}
* )
*
* @OA\Get( * @OA\Get(
* path="/producers", * path="/producers",
* operationId="getProducers", * operationId="getProducers",

210
app/Http/Resources/V4/ReviewsResource.php
View File

@ -19,17 +19,57 @@ class ReviewsResource extends JsonResource
* @OA\Property( * @OA\Property(
* property="url", * property="url",
* type="string", * type="string",
* description="MyAnimeList URL" * description="MyAnimeList review URL"
* ), * ),
* @OA\Property( * @OA\Property(
* property="type", * property="type",
* type="string", * type="string",
* description="Entry Type" * description="Entry type"
* ), * ),
* @OA\Property( * @OA\Property(
* property="votes", * property="reactions",
* type="integer", * type="object",
* description="Number of user votes on the Review" * description="User reaction count on the review",
* @OA\Property(
* property="overall",
* type="integer",
* description="Overall reaction count"
* ),
* @OA\Property(
* property="nice",
* type="integer",
* description="Nice reaction count"
* ),
* @OA\Property(
* property="love_it",
* type="integer",
* description="Love it reaction count"
* ),
* @OA\Property(
* property="funny",
* type="integer",
* description="Funny reaction count"
* ),
* @OA\Property(
* property="confusing",
* type="integer",
* description="Confusing reaction count"
* ),
* @OA\Property(
* property="informative",
* type="integer",
* description="Informative reaction count"
* ),
* @OA\Property(
* property="well_written",
* type="integer",
* description="Well written reaction count"
* ),
* @OA\Property(
* property="creative",
* type="integer",
* description="Creative reaction count"
* )
* ), * ),
* @OA\Property( * @OA\Property(
* property="date", * property="date",
@ -37,44 +77,30 @@ class ReviewsResource extends JsonResource
* description="Review created date ISO8601" * description="Review created date ISO8601"
* ), * ),
* @OA\Property( * @OA\Property(
* property="chapters_read",
* type="integer",
* description="Number of chapters read by the reviewer"
* ),
* @OA\Property(
* property="review", * property="review",
* type="string", * type="string",
* description="Review content" * description="Review content"
* ), * ),
* @OA\Property( * @OA\Property(
* property="scores", * property="score",
* type="object", * type="integer",
* description="Review Scores breakdown", * description="Number of user votes on the Review"
* @OA\Property( * ),
* property="overall", * @OA\Property (
* type="integer", * property="tags",
* description="Overall Score" * type="array",
* ), * description="Review tags",
* @OA\Property( * @OA\Items(type="string"),
* property="story", * ),
* type="integer", * @OA\Property (
* description="Story Score" * property="is_spoiler",
* ), * type="bool",
* @OA\Property( * description="The review contains spoiler"
* property="art", * ),
* type="integer", * @OA\Property (
* description="Art Score" * property="is_preliminary",
* ), * type="bool",
* @OA\Property( * description="The review was made before the entry was completed"
* property="character",
* type="integer",
* description="Character Score"
* ),
* @OA\Property(
* property="enjoyment",
* type="integer",
* description="Enjoyment Score"
* ),
* ), * ),
* ), * ),
* *
@ -89,17 +115,57 @@ class ReviewsResource extends JsonResource
* @OA\Property( * @OA\Property(
* property="url", * property="url",
* type="string", * type="string",
* description="MyAnimeList URL" * description="MyAnimeList review URL"
* ), * ),
* @OA\Property( * @OA\Property(
* property="type", * property="type",
* type="string", * type="string",
* description="Entry Type" * description="Entry type"
* ), * ),
* @OA\Property( * @OA\Property(
* property="votes", * property="reactions",
* type="integer", * type="object",
* description="Number of user votes on the Review" * description="User reaction count on the review",
* @OA\Property(
* property="overall",
* type="integer",
* description="Overall reaction count"
* ),
* @OA\Property(
* property="nice",
* type="integer",
* description="Nice reaction count"
* ),
* @OA\Property(
* property="love_it",
* type="integer",
* description="Love it reaction count"
* ),
* @OA\Property(
* property="funny",
* type="integer",
* description="Funny reaction count"
* ),
* @OA\Property(
* property="confusing",
* type="integer",
* description="Confusing reaction count"
* ),
* @OA\Property(
* property="informative",
* type="integer",
* description="Informative reaction count"
* ),
* @OA\Property(
* property="well_written",
* type="integer",
* description="Well written reaction count"
* ),
* @OA\Property(
* property="creative",
* type="integer",
* description="Creative reaction count"
* )
* ), * ),
* @OA\Property( * @OA\Property(
* property="date", * property="date",
@ -112,45 +178,31 @@ class ReviewsResource extends JsonResource
* description="Review content" * description="Review content"
* ), * ),
* @OA\Property( * @OA\Property(
* property="score",
* type="integer",
* description="Number of user votes on the Review"
* ),
* @OA\Property (
* property="tags",
* type="array",
* description="Review tags",
* @OA\Items(type="string"),
* ),
* @OA\Property (
* property="is_spoiler",
* type="bool",
* description="The review contains spoiler"
* ),
* @OA\Property (
* property="is_preliminary",
* type="bool",
* description="The review was made before the entry was completed"
* ),
* @OA\Property(
* property="episodes_watched", * property="episodes_watched",
* type="integer", * type="integer",
* description="Number of episodes watched" * description="Number of episodes watched"
* ), * ),
* @OA\Property(
* property="scores",
* type="object",
* description="Review Scores breakdown",
* @OA\Property(
* property="overall",
* type="integer",
* description="Overall Score"
* ),
* @OA\Property(
* property="story",
* type="integer",
* description="Story Score"
* ),
* @OA\Property(
* property="animation",
* type="integer",
* description="Animation Score"
* ),
* @OA\Property(
* property="sound",
* type="integer",
* description="Sound Score"
* ),
* @OA\Property(
* property="character",
* type="integer",
* description="Character Score"
* ),
* @OA\Property(
* property="enjoyment",
* type="integer",
* description="Enjoyment Score"
* ),
* ),
* ), * ),
* *
* *
@ -233,4 +285,4 @@ class ReviewsResource extends JsonResource
'data' => $this['results'], 'data' => $this['results'],
]; ];
} }
} }

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

@ -4199,6 +4199,15 @@
}, },
"type": "object" "type": "object"
}, },
"magazines_query_orderby": {
"description": "Order by magazine data",
"type": "string",
"enum": [
"mal_id",
"name",
"count"
]
},
"manga_news": { "manga_news": {
"description": "Manga News Resource", "description": "Manga News Resource",
"allOf": [ "allOf": [
@ -4323,6 +4332,16 @@
} }
] ]
}, },
"producers_query_orderby": {
"description": "Producers Search Query Order By",
"type": "string",
"enum": [
"mal_id",
"count",
"favorites",
"established"
]
},
"seasons": { "seasons": {
"description": "List of available seasons", "description": "List of available seasons",
"properties": { "properties": {
@ -4638,15 +4657,6 @@
"created" "created"
] ]
}, },
"magazines_query_orderby": {
"description": "Order by magazine data",
"type": "string",
"enum": [
"mal_id",
"name",
"count"
]
},
"manga_search_query_type": { "manga_search_query_type": {
"description": "Available Manga types", "description": "Available Manga types",
"type": "string", "type": "string",
@ -4699,17 +4709,6 @@
"favorites" "favorites"
] ]
}, },
"producers_query_orderby": {
"description": "Order by producers data",
"type": "string",
"enum": [
"mal_id",
"name",
"count",
"favorites",
"established"
]
},
"users_search_query_gender": { "users_search_query_gender": {
"description": "Users Search Query Gender", "description": "Users Search Query Gender",
"type": "string", "type": "string",
@ -8467,54 +8466,77 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "MyAnimeList URL", "description": "MyAnimeList review URL",
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "Entry Type", "description": "Entry type",
"type": "string" "type": "string"
}, },
"votes": { "reactions": {
"description": "Number of user votes on the Review", "description": "User reaction count on the review",
"type": "integer" "properties": {
"overall": {
"description": "Overall reaction count",
"type": "integer"
},
"nice": {
"description": "Nice reaction count",
"type": "integer"
},
"love_it": {
"description": "Love it reaction count",
"type": "integer"
},
"funny": {
"description": "Funny reaction count",
"type": "integer"
},
"confusing": {
"description": "Confusing reaction count",
"type": "integer"
},
"informative": {
"description": "Informative reaction count",
"type": "integer"
},
"well_written": {
"description": "Well written reaction count",
"type": "integer"
},
"creative": {
"description": "Creative reaction count",
"type": "integer"
}
},
"type": "object"
}, },
"date": { "date": {
"description": "Review created date ISO8601", "description": "Review created date ISO8601",
"type": "string" "type": "string"
}, },
"chapters_read": {
"description": "Number of chapters read by the reviewer",
"type": "integer"
},
"review": { "review": {
"description": "Review content", "description": "Review content",
"type": "string" "type": "string"
}, },
"scores": { "score": {
"description": "Review Scores breakdown", "description": "Number of user votes on the Review",
"properties": { "type": "integer"
"overall": { },
"description": "Overall Score", "tags": {
"type": "integer" "description": "Review tags",
}, "type": "array",
"story": { "items": {
"description": "Story Score", "type": "string"
"type": "integer" }
}, },
"art": { "is_spoiler": {
"description": "Art Score", "description": "The review contains spoiler",
"type": "integer" "type": "bool"
}, },
"character": { "is_preliminary": {
"description": "Character Score", "description": "The review was made before the entry was completed",
"type": "integer" "type": "bool"
},
"enjoyment": {
"description": "Enjoyment Score",
"type": "integer"
}
},
"type": "object"
} }
}, },
"type": "object" "type": "object"
@ -8526,16 +8548,50 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "MyAnimeList URL", "description": "MyAnimeList review URL",
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "Entry Type", "description": "Entry type",
"type": "string" "type": "string"
}, },
"votes": { "reactions": {
"description": "Number of user votes on the Review", "description": "User reaction count on the review",
"type": "integer" "properties": {
"overall": {
"description": "Overall reaction count",
"type": "integer"
},
"nice": {
"description": "Nice reaction count",
"type": "integer"
},
"love_it": {
"description": "Love it reaction count",
"type": "integer"
},
"funny": {
"description": "Funny reaction count",
"type": "integer"
},
"confusing": {
"description": "Confusing reaction count",
"type": "integer"
},
"informative": {
"description": "Informative reaction count",
"type": "integer"
},
"well_written": {
"description": "Well written reaction count",
"type": "integer"
},
"creative": {
"description": "Creative reaction count",
"type": "integer"
}
},
"type": "object"
}, },
"date": { "date": {
"description": "Review created date ISO8601", "description": "Review created date ISO8601",
@ -8545,39 +8601,28 @@
"description": "Review content", "description": "Review content",
"type": "string" "type": "string"
}, },
"score": {
"description": "Number of user votes on the Review",
"type": "integer"
},
"tags": {
"description": "Review tags",
"type": "array",
"items": {
"type": "string"
}
},
"is_spoiler": {
"description": "The review contains spoiler",
"type": "bool"
},
"is_preliminary": {
"description": "The review was made before the entry was completed",
"type": "bool"
},
"episodes_watched": { "episodes_watched": {
"description": "Number of episodes watched", "description": "Number of episodes watched",
"type": "integer" "type": "integer"
},
"scores": {
"description": "Review Scores breakdown",
"properties": {
"overall": {
"description": "Overall Score",
"type": "integer"
},
"story": {
"description": "Story Score",
"type": "integer"
},
"animation": {
"description": "Animation Score",
"type": "integer"
},
"sound": {
"description": "Sound Score",
"type": "integer"
},
"character": {
"description": "Character Score",
"type": "integer"
},
"enjoyment": {
"description": "Enjoyment Score",
"type": "integer"
}
},
"type": "object"
} }
}, },
"type": "object" "type": "object"