From 897e4855c18412e5f24ec3dfc753db447db5ad7b Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 6 Oct 2019 22:24:54 +1100 Subject: [PATCH] OpenAPI --- app/Http/Controllers/Auth/LoginController.php | 9 +++++---- app/Http/Controllers/OpenAPI/CompanySchema.php | 14 -------------- app/Http/Controllers/OpenAPI/ErrorSchema.php | 9 +++++++++ 3 files changed, 14 insertions(+), 18 deletions(-) create mode 100644 app/Http/Controllers/OpenAPI/ErrorSchema.php diff --git a/app/Http/Controllers/Auth/LoginController.php b/app/Http/Controllers/Auth/LoginController.php index 049592d03..5b081d77e 100644 --- a/app/Http/Controllers/Auth/LoginController.php +++ b/app/Http/Controllers/Auth/LoginController.php @@ -141,10 +141,11 @@ class LoginController extends BaseController * @OA\JsonContent(ref="#/components/schemas/Company"), * ), - * @OA\Response(response=400, description="Bad request"), - * security={ - * {"": {}} - * } + * @OA\Response( + * response="default", + * description="Unexpected Error", + * @OA\JsonContent(ref="#/components/schemas/Error"), + * ), * ) * * @OA\Response( diff --git a/app/Http/Controllers/OpenAPI/CompanySchema.php b/app/Http/Controllers/OpenAPI/CompanySchema.php index 8f8f743d6..01cf24cfd 100644 --- a/app/Http/Controllers/OpenAPI/CompanySchema.php +++ b/app/Http/Controllers/OpenAPI/CompanySchema.php @@ -3,22 +3,8 @@ /** * @OA\Schema( * schema="Company", - * allOf={ - * @OA\Schema( * @OA\Property(property="id", type="string", example="WJxbojagwO", description="The company hash id"), * @OA\Property(property="name", type="string", example="The local shop", description="The company name"), * @OA\Property(property="logo", type="object", example="logo.png", description="The company logo - binary"), - * @OA\Property(property="logo_url", type="string", example="http://example.com/logo.png", description="The company logo url"), - * ) - * } - * ) - */ - -/** - * @OA\Schema( - * schema="product_id", - * type="integer", - * format="int64", - * description="The unique identifier of a product in our catalog" * ) */ \ No newline at end of file diff --git a/app/Http/Controllers/OpenAPI/ErrorSchema.php b/app/Http/Controllers/OpenAPI/ErrorSchema.php new file mode 100644 index 000000000..fca2c809b --- /dev/null +++ b/app/Http/Controllers/OpenAPI/ErrorSchema.php @@ -0,0 +1,9 @@ +