mirror of
https://github.com/jikan-me/jikan-rest.git
synced 2025-02-20 11:23:35 +08:00
docs: update
This commit is contained in:
Irfan
parent
fafdd42ef5
commit
d1a08e2c17
@ -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(
|
||||
* path="/producers",
|
||||
* operationId="getProducers",
|
||||
|
||||
@ -19,17 +19,57 @@ class ReviewsResource extends JsonResource
|
||||
* @OA\Property(
|
||||
* property="url",
|
||||
* type="string",
|
||||
* description="MyAnimeList URL"
|
||||
* description="MyAnimeList review URL"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="type",
|
||||
* type="string",
|
||||
* description="Entry Type"
|
||||
* description="Entry type"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="votes",
|
||||
* type="integer",
|
||||
* description="Number of user votes on the Review"
|
||||
* property="reactions",
|
||||
* type="object",
|
||||
* 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(
|
||||
* property="date",
|
||||
@ -37,44 +77,30 @@ class ReviewsResource extends JsonResource
|
||||
* description="Review created date ISO8601"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="chapters_read",
|
||||
* type="integer",
|
||||
* description="Number of chapters read by the reviewer"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="review",
|
||||
* type="string",
|
||||
* description="Review content"
|
||||
* ),
|
||||
* @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="art",
|
||||
* type="integer",
|
||||
* description="Art Score"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="character",
|
||||
* type="integer",
|
||||
* description="Character Score"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="enjoyment",
|
||||
* type="integer",
|
||||
* description="Enjoyment Score"
|
||||
* ),
|
||||
* 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"
|
||||
* ),
|
||||
* ),
|
||||
*
|
||||
@ -89,17 +115,57 @@ class ReviewsResource extends JsonResource
|
||||
* @OA\Property(
|
||||
* property="url",
|
||||
* type="string",
|
||||
* description="MyAnimeList URL"
|
||||
* description="MyAnimeList review URL"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="type",
|
||||
* type="string",
|
||||
* description="Entry Type"
|
||||
* description="Entry type"
|
||||
* ),
|
||||
* @OA\Property(
|
||||
* property="votes",
|
||||
* type="integer",
|
||||
* description="Number of user votes on the Review"
|
||||
* property="reactions",
|
||||
* type="object",
|
||||
* 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(
|
||||
* property="date",
|
||||
@ -112,45 +178,31 @@ class ReviewsResource extends JsonResource
|
||||
* description="Review content"
|
||||
* ),
|
||||
* @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",
|
||||
* type="integer",
|
||||
* 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'],
|
||||
];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -4199,6 +4199,15 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"magazines_query_orderby": {
|
||||
"description": "Order by magazine data",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"mal_id",
|
||||
"name",
|
||||
"count"
|
||||
]
|
||||
},
|
||||
"manga_news": {
|
||||
"description": "Manga News Resource",
|
||||
"allOf": [
|
||||
@ -4323,6 +4332,16 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"producers_query_orderby": {
|
||||
"description": "Producers Search Query Order By",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"mal_id",
|
||||
"count",
|
||||
"favorites",
|
||||
"established"
|
||||
]
|
||||
},
|
||||
"seasons": {
|
||||
"description": "List of available seasons",
|
||||
"properties": {
|
||||
@ -4638,15 +4657,6 @@
|
||||
"created"
|
||||
]
|
||||
},
|
||||
"magazines_query_orderby": {
|
||||
"description": "Order by magazine data",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"mal_id",
|
||||
"name",
|
||||
"count"
|
||||
]
|
||||
},
|
||||
"manga_search_query_type": {
|
||||
"description": "Available Manga types",
|
||||
"type": "string",
|
||||
@ -4699,17 +4709,6 @@
|
||||
"favorites"
|
||||
]
|
||||
},
|
||||
"producers_query_orderby": {
|
||||
"description": "Order by producers data",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"mal_id",
|
||||
"name",
|
||||
"count",
|
||||
"favorites",
|
||||
"established"
|
||||
]
|
||||
},
|
||||
"users_search_query_gender": {
|
||||
"description": "Users Search Query Gender",
|
||||
"type": "string",
|
||||
@ -8467,54 +8466,77 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"url": {
|
||||
"description": "MyAnimeList URL",
|
||||
"description": "MyAnimeList review URL",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "Entry Type",
|
||||
"description": "Entry type",
|
||||
"type": "string"
|
||||
},
|
||||
"votes": {
|
||||
"description": "Number of user votes on the Review",
|
||||
"type": "integer"
|
||||
"reactions": {
|
||||
"description": "User reaction count on the review",
|
||||
"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": {
|
||||
"description": "Review created date ISO8601",
|
||||
"type": "string"
|
||||
},
|
||||
"chapters_read": {
|
||||
"description": "Number of chapters read by the reviewer",
|
||||
"type": "integer"
|
||||
},
|
||||
"review": {
|
||||
"description": "Review content",
|
||||
"type": "string"
|
||||
},
|
||||
"scores": {
|
||||
"description": "Review Scores breakdown",
|
||||
"properties": {
|
||||
"overall": {
|
||||
"description": "Overall Score",
|
||||
"type": "integer"
|
||||
},
|
||||
"story": {
|
||||
"description": "Story Score",
|
||||
"type": "integer"
|
||||
},
|
||||
"art": {
|
||||
"description": "Art Score",
|
||||
"type": "integer"
|
||||
},
|
||||
"character": {
|
||||
"description": "Character Score",
|
||||
"type": "integer"
|
||||
},
|
||||
"enjoyment": {
|
||||
"description": "Enjoyment Score",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@ -8526,16 +8548,50 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"url": {
|
||||
"description": "MyAnimeList URL",
|
||||
"description": "MyAnimeList review URL",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "Entry Type",
|
||||
"description": "Entry type",
|
||||
"type": "string"
|
||||
},
|
||||
"votes": {
|
||||
"description": "Number of user votes on the Review",
|
||||
"type": "integer"
|
||||
"reactions": {
|
||||
"description": "User reaction count on the review",
|
||||
"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": {
|
||||
"description": "Review created date ISO8601",
|
||||
@ -8545,39 +8601,28 @@
|
||||
"description": "Review content",
|
||||
"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": {
|
||||
"description": "Number of episodes watched",
|
||||
"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"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user