From 7318eb19d8a30f7796bc7ff066359e393c6918b9 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Thu, 30 Jul 2020 13:27:00 +1000 Subject: [PATCH] OPENAPI docs --- app/Http/Controllers/AccountController.php | 2 +- .../Controllers/CompanyUserController.php | 11 ---------- app/Http/Controllers/LicenseController.php | 4 ++-- app/Http/Controllers/MigrationController.php | 2 +- app/Http/Controllers/OpenAPI/Parameters.php | 2 +- app/Http/Controllers/PreviewController.php | 22 ------------------- app/Http/Controllers/TemplateController.php | 22 ------------------- 7 files changed, 5 insertions(+), 60 deletions(-) diff --git a/app/Http/Controllers/AccountController.php b/app/Http/Controllers/AccountController.php index cac67e2c27dd..066be576d1ad 100644 --- a/app/Http/Controllers/AccountController.php +++ b/app/Http/Controllers/AccountController.php @@ -72,7 +72,7 @@ class AccountController extends BaseController * @OA\Parameter(ref="#/components/parameters/X-Requested-With"), * @OA\Parameter( * name="token_name", - * in="path", + * in="query", * description="A custom name for the user company token", * example="Daves iOS Device", * required=true, diff --git a/app/Http/Controllers/CompanyUserController.php b/app/Http/Controllers/CompanyUserController.php index fa6d5ccfb9d2..50412f4a75cf 100644 --- a/app/Http/Controllers/CompanyUserController.php +++ b/app/Http/Controllers/CompanyUserController.php @@ -87,17 +87,6 @@ class CompanyUserController extends BaseController * description="Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users", * @OA\Parameter(ref="#/components/parameters/X-Api-Secret"), * @OA\Parameter(ref="#/components/parameters/X-Requested-With"), - * @OA\Parameter( - * name="id", - * in="path", - * description="The Invoice Hashed ID", - * example="D2J234DFA", - * required=true, - * @OA\Schema( - * type="string", - * format="string", - * ), - * ), * @OA\Response( * response=200, * description="The Company User response", diff --git a/app/Http/Controllers/LicenseController.php b/app/Http/Controllers/LicenseController.php index 7c80e8faad7c..090bdbd7edd3 100644 --- a/app/Http/Controllers/LicenseController.php +++ b/app/Http/Controllers/LicenseController.php @@ -39,7 +39,7 @@ class LicenseController extends BaseController * @OA\Parameter(ref="#/components/parameters/X-Requested-With"), * @OA\Parameter( * name="license_key", - * in="path", + * in="query", * description="The license hash", * example="d87sh-s755s-s7d76-sdsd8", * required=true, @@ -50,7 +50,7 @@ class LicenseController extends BaseController * ), * @OA\Parameter( * name="product_id", - * in="path", + * in="query", * description="The ID of the product purchased.", * example="1", * required=true, diff --git a/app/Http/Controllers/MigrationController.php b/app/Http/Controllers/MigrationController.php index b2369aa84a8f..86eb1e343ef3 100644 --- a/app/Http/Controllers/MigrationController.php +++ b/app/Http/Controllers/MigrationController.php @@ -162,7 +162,7 @@ class MigrationController extends BaseController * @OA\Parameter(ref="#/components/parameters/X-Api-Password"), * @OA\Parameter( * name="migration", - * in="path", + * in="query", * description="The migraton file", * example="migration.zip", * required=true, diff --git a/app/Http/Controllers/OpenAPI/Parameters.php b/app/Http/Controllers/OpenAPI/Parameters.php index 783cd1f26742..6cce8170694a 100644 --- a/app/Http/Controllers/OpenAPI/Parameters.php +++ b/app/Http/Controllers/OpenAPI/Parameters.php @@ -85,7 +85,7 @@ * ), * * @OA\Parameter( - * name="", + * name="api_version", * in="query", * description="The API version", * @OA\Schema( diff --git a/app/Http/Controllers/PreviewController.php b/app/Http/Controllers/PreviewController.php index af98d00b7676..c9aeca9c75c9 100644 --- a/app/Http/Controllers/PreviewController.php +++ b/app/Http/Controllers/PreviewController.php @@ -45,28 +45,6 @@ class PreviewController extends BaseController * description="Returns a pdf preview.", * @OA\Parameter(ref="#/components/parameters/X-Api-Secret"), * @OA\Parameter(ref="#/components/parameters/X-Requested-With"), - * @OA\Parameter( - * name="entity", - * in="path", - * description="The PDF", - * example="invoice", - * required=true, - * @OA\Schema( - * type="string", - * format="string", - * ), - * ), - * @OA\Parameter( - * name="entity_id", - * in="path", - * description="The Entity ID", - * example="X9f87dkf", - * required=true, - * @OA\Schema( - * type="string", - * format="string", - * ), - * ), * @OA\Response( * response=200, * description="The pdf response", diff --git a/app/Http/Controllers/TemplateController.php b/app/Http/Controllers/TemplateController.php index d463e175e87d..35aae2320e2e 100644 --- a/app/Http/Controllers/TemplateController.php +++ b/app/Http/Controllers/TemplateController.php @@ -42,28 +42,6 @@ class TemplateController extends BaseController * description="Returns a entity template with the template variables replaced with the Entities", * @OA\Parameter(ref="#/components/parameters/X-Api-Secret"), * @OA\Parameter(ref="#/components/parameters/X-Requested-With"), - * @OA\Parameter( - * name="entity", - * in="path", - * description="The Entity (invoice,quote,recurring_invoice)", - * example="invoice", - * required=true, - * @OA\Schema( - * type="string", - * format="string", - * ), - * ), - * @OA\Parameter( - * name="entity_id", - * in="path", - * description="The Entity ID", - * example="X9f87dkf", - * required=true, - * @OA\Schema( - * type="string", - * format="string", - * ), - * ), * @OA\RequestBody( * description="The template subject and body", * required=true,