Skip to content

Commit

Permalink
update docs [#490]: Random API: adds sfw and unapproved
Browse files Browse the repository at this point in the history
  • Loading branch information
@irfan-dahir
irfan-dahir committed Nov 13, 2024
1 parent 389b58a commit 0442af7
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 10 deletions.
25 changes: 20 additions & 5 deletions app/Http/Controllers/V4DB/RandomController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ class RandomController extends Controller
* operationId="getRandomAnime",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/limit"),
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
*
* @OA\Response(
* response="200",
Expand Down Expand Up @@ -73,6 +74,8 @@ public function anime(QueryRandomAnimeCommand $command)
* operationId="getRandomAnimeList",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Response(
Expand Down Expand Up @@ -106,7 +109,8 @@ public function animeList(QueryRandomAnimeListCommand $command)
* operationId="getRandomManga",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/limit"),
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
*
* @OA\Response(
* response="200",
Expand Down Expand Up @@ -135,6 +139,8 @@ public function manga(QueryRandomMangaCommand $command)
* operationId="getRandomMangaList",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Response(
Expand Down Expand Up @@ -168,7 +174,8 @@ public function mangaList(QueryRandomAnimeListCommand $command)
* operationId="getRandomCharacters",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/limit"),
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
*
* @OA\Response(
* response="200",
Expand Down Expand Up @@ -197,6 +204,8 @@ public function characters(QueryRandomCharacterCommand $command)
* operationId="getRandomCharactersList",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Response(
Expand Down Expand Up @@ -230,7 +239,8 @@ public function charactersList(QueryRandomCharacterListCommand $command)
* operationId="getRandomPeople",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/limit"),
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
*
* @OA\Response(
* response="200",
Expand Down Expand Up @@ -259,6 +269,8 @@ public function people(QueryRandomPersonCommand $command)
* operationId="getRandomPeopleList",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Response(
Expand Down Expand Up @@ -292,7 +304,8 @@ public function peopleList(QueryRandomPersonListCommand $command)
* operationId="getRandomUsers",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/limit"),
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
*
* @OA\Response(
* response="200",
Expand Down Expand Up @@ -321,6 +334,8 @@ public function users(QueryRandomUserCommand $command)
* operationId="getRandomUsersList",
* tags={"random"},
*
* @OA\Parameter(ref="#/components/parameters/sfw"),
* @OA\Parameter(ref="#/components/parameters/unapproved"),
* @OA\Parameter(ref="#/components/parameters/limit"),
*
* @OA\Response(
Expand Down
55 changes: 50 additions & 5 deletions storage/api-docs/api-docs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2024,7 +2024,10 @@
"operationId": "getRandomAnime",
"parameters": [
{
"$ref": "#/components/parameters/limit"
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
}
],
"responses": {
Expand Down Expand Up @@ -2056,6 +2059,12 @@
],
"operationId": "getRandomAnimeList",
"parameters": [
{
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
},
{
"$ref": "#/components/parameters/limit"
}
Expand Down Expand Up @@ -2093,7 +2102,10 @@
"operationId": "getRandomManga",
"parameters": [
{
"$ref": "#/components/parameters/limit"
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
}
],
"responses": {
Expand Down Expand Up @@ -2125,6 +2137,12 @@
],
"operationId": "getRandomMangaList",
"parameters": [
{
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
},
{
"$ref": "#/components/parameters/limit"
}
Expand Down Expand Up @@ -2162,7 +2180,10 @@
"operationId": "getRandomCharacters",
"parameters": [
{
"$ref": "#/components/parameters/limit"
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
}
],
"responses": {
Expand Down Expand Up @@ -2194,6 +2215,12 @@
],
"operationId": "getRandomCharactersList",
"parameters": [
{
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
},
{
"$ref": "#/components/parameters/limit"
}
Expand Down Expand Up @@ -2231,7 +2258,10 @@
"operationId": "getRandomPeople",
"parameters": [
{
"$ref": "#/components/parameters/limit"
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
}
],
"responses": {
Expand Down Expand Up @@ -2263,6 +2293,12 @@
],
"operationId": "getRandomPeopleList",
"parameters": [
{
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
},
{
"$ref": "#/components/parameters/limit"
}
Expand Down Expand Up @@ -2300,7 +2336,10 @@
"operationId": "getRandomUsers",
"parameters": [
{
"$ref": "#/components/parameters/limit"
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
}
],
"responses": {
Expand Down Expand Up @@ -2332,6 +2371,12 @@
],
"operationId": "getRandomUsersList",
"parameters": [
{
"$ref": "#/components/parameters/sfw"
},
{
"$ref": "#/components/parameters/unapproved"
},
{
"$ref": "#/components/parameters/limit"
}
Expand Down

0 comments on commit 0442af7

Please sign in to comment.