diff --git a/app/Api/V1/Controllers/Models/Account/DestroyController.php b/app/Api/V1/Controllers/Models/Account/DestroyController.php index 308d8b9669..7819d78003 100644 --- a/app/Api/V1/Controllers/Models/Account/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Account/DestroyController.php @@ -56,6 +56,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/accounts/deleteAccount + * * Remove the specified resource from storage. * * @param Account $account diff --git a/app/Api/V1/Controllers/Models/Account/ListController.php b/app/Api/V1/Controllers/Models/Account/ListController.php index 40712fa649..4af6ff0e74 100644 --- a/app/Api/V1/Controllers/Models/Account/ListController.php +++ b/app/Api/V1/Controllers/Models/Account/ListController.php @@ -24,6 +24,7 @@ declare(strict_types=1); namespace FireflyIII\Api\V1\Controllers\Models\Account; use FireflyIII\Api\V1\Controllers\Controller; +use FireflyIII\Exceptions\FireflyException; use FireflyIII\Helpers\Collector\GroupCollectorInterface; use FireflyIII\Models\Account; use FireflyIII\Repositories\Account\AccountRepositoryInterface; @@ -69,11 +70,14 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/accounts/listAttachmentByAccount + * * @param Account $account * * @return JsonResponse - * @throws \FireflyIII\Exceptions\FireflyException * @codeCoverageIgnore + * @throws FireflyException */ public function attachments(Account $account): JsonResponse { @@ -99,12 +103,13 @@ class ListController extends Controller } /** - * List all piggies. + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/accounts/listPiggyBankByAccount * * @param Account $account * * @return JsonResponse - * @throws \FireflyIII\Exceptions\FireflyException + * @throws FireflyException * @codeCoverageIgnore */ public function piggyBanks(Account $account): JsonResponse @@ -136,6 +141,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/accounts/listTransactionByAccount + * * Show all transaction groups related to the account. * * @codeCoverageIgnore diff --git a/app/Api/V1/Controllers/Models/Account/ShowController.php b/app/Api/V1/Controllers/Models/Account/ShowController.php index da92bbb9fa..21558e14a1 100644 --- a/app/Api/V1/Controllers/Models/Account/ShowController.php +++ b/app/Api/V1/Controllers/Models/Account/ShowController.php @@ -65,6 +65,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/accounts/listAccount + * * Display a listing of the resource. * * @param Request $request @@ -108,6 +111,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/accounts/getAccount + * * Show single instance. * * @param Account $account diff --git a/app/Api/V1/Controllers/Models/Account/StoreController.php b/app/Api/V1/Controllers/Models/Account/StoreController.php index db5226a614..c18f94be4c 100644 --- a/app/Api/V1/Controllers/Models/Account/StoreController.php +++ b/app/Api/V1/Controllers/Models/Account/StoreController.php @@ -58,6 +58,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/accounts/storeAccount + * * Store a new instance. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/Account/UpdateController.php b/app/Api/V1/Controllers/Models/Account/UpdateController.php index e200977673..65221bbeda 100644 --- a/app/Api/V1/Controllers/Models/Account/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Account/UpdateController.php @@ -61,6 +61,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/accounts/updateAccount + * * Update account. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/Attachment/DestroyController.php b/app/Api/V1/Controllers/Models/Attachment/DestroyController.php index 9e52a073ec..3fad5d77bd 100644 --- a/app/Api/V1/Controllers/Models/Attachment/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Attachment/DestroyController.php @@ -59,6 +59,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/attachments/deleteAttachment + * * Remove the specified resource from storage. * * @codeCoverageIgnore diff --git a/app/Api/V1/Controllers/Models/Attachment/ShowController.php b/app/Api/V1/Controllers/Models/Attachment/ShowController.php index 85affcfddd..e724d80d52 100644 --- a/app/Api/V1/Controllers/Models/Attachment/ShowController.php +++ b/app/Api/V1/Controllers/Models/Attachment/ShowController.php @@ -66,6 +66,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/attachments/downloadAttachment + * * Download an attachment. * * @param Attachment $attachment @@ -108,6 +111,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/attachments/listAttachment + * * Display a listing of the resource. * * @return JsonResponse @@ -141,6 +147,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/attachments/getAttachment + * * Display the specified resource. * * @param Attachment $attachment diff --git a/app/Api/V1/Controllers/Models/Attachment/StoreController.php b/app/Api/V1/Controllers/Models/Attachment/StoreController.php index eba7ead400..2469b68938 100644 --- a/app/Api/V1/Controllers/Models/Attachment/StoreController.php +++ b/app/Api/V1/Controllers/Models/Attachment/StoreController.php @@ -66,6 +66,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/attachments/uploadAttachment + * * Store a newly created resource in storage. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/Attachment/UpdateController.php b/app/Api/V1/Controllers/Models/Attachment/UpdateController.php index e560fbb084..f5d350b1e4 100644 --- a/app/Api/V1/Controllers/Models/Attachment/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Attachment/UpdateController.php @@ -62,6 +62,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/attachments/updateAttachment + * * Update the specified resource in storage. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/AvailableBudget/DestroyController.php b/app/Api/V1/Controllers/Models/AvailableBudget/DestroyController.php index 27ca1d5608..0297e839c7 100644 --- a/app/Api/V1/Controllers/Models/AvailableBudget/DestroyController.php +++ b/app/Api/V1/Controllers/Models/AvailableBudget/DestroyController.php @@ -57,6 +57,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/available_budgets/listAvailableBudget + * * Remove the specified resource from storage. * * @param AvailableBudget $availableBudget diff --git a/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php b/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php index eeaa2ab5fd..212178597d 100644 --- a/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php +++ b/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php @@ -24,6 +24,7 @@ declare(strict_types=1); namespace FireflyIII\Api\V1\Controllers\Models\AvailableBudget; use FireflyIII\Api\V1\Controllers\Controller; +use FireflyIII\Exceptions\FireflyException; use FireflyIII\Models\AvailableBudget; use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface; use FireflyIII\Transformers\AvailableBudgetTransformer; @@ -62,10 +63,13 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/available_budgets/getAvailableBudget + * * Display a listing of the resource. * * @return JsonResponse - * @throws \FireflyIII\Exceptions\FireflyException + * @throws FireflyException * @codeCoverageIgnore */ public function index(): JsonResponse