Merge branch 'release/5.6.1'

app/Api/V1/Controllers/Autocomplete/AccountController.php

@@ -25,12 +25,14 @@ namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
 use FireflyIII\Models\AccountType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Support\Http\Api\AccountFilter;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use JsonException;
 
 /**
  * Class AccountController
@@ -62,9 +64,14 @@ class AccountController extends Controller
     }
 
     /**
+     * Documentation for this endpoint:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getAccountsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
+     * @throws FireflyException
+     * @throws JsonException
      */
     public function accounts(AutocompleteRequest $request): JsonResponse
     {

app/Api/V1/Controllers/Autocomplete/BillController.php

@@ -56,6 +56,9 @@ class BillController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getBillsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Autocomplete/BudgetController.php

@@ -56,6 +56,9 @@ class BudgetController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getBudgetsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Autocomplete/CategoryController.php

@@ -56,6 +56,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getCategoriesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Autocomplete/CurrencyController.php

@@ -56,6 +56,9 @@ class CurrencyController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getCurrenciesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -81,9 +84,13 @@ class CurrencyController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getCurrenciesCodeAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
+     * @deprecated
      */
     public function currenciesWithCode(AutocompleteRequest $request): JsonResponse
     {

app/Api/V1/Controllers/Autocomplete/ObjectGroupController.php

@@ -56,6 +56,9 @@ class ObjectGroupController extends Controller
     }
 
     /**
+     * Documentation for this endpoint is at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getObjectGroupsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Autocomplete/PiggyBankController.php

@@ -36,7 +36,7 @@ use Illuminate\Http\JsonResponse;
  */
 class PiggyBankController extends Controller
 {
-    private AccountRepositoryInterface $accountRepository;
+    private AccountRepositoryInterface   $accountRepository;
     private PiggyBankRepositoryInterface $piggyRepository;
 
     /**
@@ -60,6 +60,9 @@ class PiggyBankController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getPiggiesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -80,6 +83,7 @@ class PiggyBankController extends Controller
                 'currency_id'             => $currency->id,
                 'currency_name'           => $currency->name,
                 'currency_code'           => $currency->code,
+                'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
             ];
         }
@@ -88,6 +92,9 @@ class PiggyBankController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getPiggiesBalanceAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -112,6 +119,7 @@ class PiggyBankController extends Controller
                 'currency_id'             => $currency->id,
                 'currency_name'           => $currency->name,
                 'currency_code'           => $currency->code,
+                'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
             ];
         }

app/Api/V1/Controllers/Autocomplete/RecurrenceController.php

@@ -25,7 +25,7 @@ namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
-use FireflyIII\Models\Rule;
+use FireflyIII\Models\Recurrence;
 use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
 use Illuminate\Http\JsonResponse;
 
@@ -53,22 +53,25 @@ class RecurrenceController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getRecurringAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
      */
     public function recurring(AutocompleteRequest $request): JsonResponse
     {
-        $data     = $request->getData();
+        $data        = $request->getData();
-        $rules    = $this->repository->searchRecurrence($data['query'], $data['limit']);
+        $recurrences = $this->repository->searchRecurrence($data['query'], $data['limit']);
-        $response = [];
+        $response    = [];
 
-        /** @var Rule $rule */
+        /** @var Recurrence $recurrence */
-        foreach ($rules as $rule) {
+        foreach ($recurrences as $recurrence) {
             $response[] = [
-                'id'          => (string)$rule->id,
+                'id'          => (string)$recurrence->id,
-                'name'        => $rule->title,
+                'name'        => $recurrence->title,
-                'description' => $rule->description,
+                'description' => $recurrence->description,
             ];
         }
 

app/Api/V1/Controllers/Autocomplete/RuleController.php

@@ -53,6 +53,9 @@ class RuleController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getRulesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Autocomplete/RuleGroupController.php

@@ -53,6 +53,9 @@ class RuleGroupController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getRuleGroupsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Autocomplete/TagController.php

@@ -56,6 +56,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getTagAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Autocomplete/TransactionController.php

@@ -61,6 +61,9 @@ class TransactionController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionsAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse
@@ -88,6 +91,9 @@ class TransactionController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionsIDAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Autocomplete/TransactionTypeController.php

@@ -52,6 +52,9 @@ class TransactionTypeController extends Controller
     }
 
     /**
+     * This endpoint is documented at
+     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionTypesAC
+     *
      * @param AutocompleteRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Chart/AccountController.php

@@ -27,6 +27,7 @@ namespace FireflyIII\Api\V1\Controllers\Chart;
 use Carbon\Carbon;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Data\DateRequest;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
 use FireflyIII\Models\AccountType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
@@ -69,9 +70,13 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/charts/getChartAccountOverview
+     *
      * @param DateRequest $request
      *
      * @return JsonResponse
+     * @throws FireflyException
      */
     public function overview(DateRequest $request): JsonResponse
     {
@@ -100,9 +105,9 @@ class AccountController extends Controller
         foreach ($accounts as $account) {
             $currency = $this->repository->getAccountCurrency($account);
             if (null === $currency) {
-                $currency = $default; 
+                $currency = $default;
             }
-            $currentSet = [
+            $currentSet   = [
                 'label'                   => $account->name,
                 'currency_id'             => (string)$currency->id,
                 'currency_code'           => $currency->code,

app/Api/V1/Controllers/Controller.php

@@ -46,8 +46,8 @@ abstract class Controller extends BaseController
     use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
 
     protected const CONTENT_TYPE = 'application/vnd.api+json';
-    protected ParameterBag $parameters;
     protected array        $allowedSort;
+    protected ParameterBag $parameters;
 
     /**
      * Controller constructor.
@@ -92,7 +92,7 @@ abstract class Controller extends BaseController
             if (null !== $date) {
                 try {
                     $obj = Carbon::parse($date);
-                } catch (InvalidDateException|InvalidFormatException $e) {
+                } catch (InvalidDateException | InvalidFormatException $e) {
                     // don't care
                     Log::error(sprintf('Invalid date exception in API controller: %s', $e->getMessage()));
                 }

app/Api/V1/Controllers/Data/Bulk/AccountController.php

@@ -57,9 +57,12 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is deprecated and not documented.
+     *
      * @param MoveTransactionsRequest $request
      *
      * @return JsonResponse
+     * @deprecated
      */
     public function moveTransactions(MoveTransactionsRequest $request): JsonResponse
     {

app/Api/V1/Controllers/Data/Bulk/TransactionController.php

@@ -61,6 +61,8 @@ class TransactionController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     *
      * @param TransactionRequest $request
      *
      * @return JsonResponse
@@ -69,12 +71,13 @@ class TransactionController extends Controller
     {
         $query  = $request->getAll();
         $params = $query['query'];
+
         // this deserves better code, but for now a loop of basic if-statements
         // to respond to what is in the $query.
         // this is OK because only one thing can be in the query at the moment.
         if ($this->updatesTransactionAccount($params)) {
-            $original    = $this->repository->find((int)$params['where']['source_account_id']);
+            $original    = $this->repository->find((int)$params['where']['account_id']);
-            $destination = $this->repository->find((int)$params['update']['destination_account_id']);
+            $destination = $this->repository->find((int)$params['update']['account_id']);
 
             /** @var AccountDestroyService $service */
             $service = app(AccountDestroyService::class);
@@ -91,7 +94,7 @@ class TransactionController extends Controller
      */
     private function updatesTransactionAccount(array $params): bool
     {
-        return array_key_exists('source_account_id', $params['where']) && array_key_exists('destination_account_id', $params['update']);
+        return array_key_exists('account_id', $params['where']) && array_key_exists('account_id', $params['update']);
     }
 
 }

app/Api/V1/Controllers/Data/DestroyController.php

@@ -52,6 +52,9 @@ use Illuminate\Http\JsonResponse;
 class DestroyController extends Controller
 {
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/destroyData
+     *
      * @param DestroyRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Data/Export/ExportController.php

@@ -26,9 +26,9 @@ namespace FireflyIII\Api\V1\Controllers\Data\Export;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Data\Export\ExportRequest;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Support\Export\ExportDataGenerator;
 use Illuminate\Http\Response as LaravelResponse;
-use League\Csv\CannotInsertRecord;
 
 /**
  * Class ExportController
@@ -54,10 +54,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportAccounts
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function accounts(ExportRequest $request): LaravelResponse
     {
@@ -71,15 +74,13 @@ class ExportController extends Controller
      * @param string $key
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
-     * @throws \FireflyIII\Exceptions\FireflyException
-     * @throws \League\Csv\Exception
      */
     private function returnExport(string $key): LaravelResponse
     {
-        $date     = date('Y-m-d-H-i-s');
+        $date = date('Y-m-d-H-i-s');
         $fileName = sprintf('%s-export-%s.csv', $date, $key);
-        $data     = $this->exporter->export();
+        $data = $this->exporter->export();
 
         /** @var LaravelResponse $response */
         $response = response($data[$key]);
@@ -98,10 +99,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportBills
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function bills(ExportRequest $request): LaravelResponse
     {
@@ -111,10 +115,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportBudgets
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function budgets(ExportRequest $request): LaravelResponse
     {
@@ -124,10 +131,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportCategories
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function categories(ExportRequest $request): LaravelResponse
     {
@@ -137,10 +147,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportPiggies
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function piggyBanks(ExportRequest $request): LaravelResponse
     {
@@ -150,10 +163,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportRecurring
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function recurring(ExportRequest $request): LaravelResponse
     {
@@ -163,10 +179,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportRules
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function rules(ExportRequest $request): LaravelResponse
     {
@@ -176,10 +195,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportTags
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function tags(ExportRequest $request): LaravelResponse
     {
@@ -189,10 +211,13 @@ class ExportController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/data/exportTransactions
+     *
      * @param ExportRequest $request
      *
      * @return LaravelResponse
-     * @throws CannotInsertRecord
+     * @throws FireflyException
      */
     public function transactions(ExportRequest $request): LaravelResponse
     {

app/Api/V1/Controllers/Insight/Expense/AccountController.php

@@ -37,7 +37,7 @@ use Illuminate\Http\JsonResponse;
  * Class AccountController
  *
  * Shows expense information grouped or limited by date.
- * Ie. all expenses grouped by account + currency.
+ * I.e. all expenses grouped by account + currency.
  */
 class AccountController extends Controller
 {
@@ -73,6 +73,9 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseAsset
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -101,6 +104,9 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseExpense
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Expense/BillController.php

@@ -56,6 +56,9 @@ class BillController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseBill
+     *
      * Expenses per bill, possibly filtered by bill and account.
      *
      * @param GenericRequest $request
@@ -116,6 +119,9 @@ class BillController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoBill
+     *
      * Expenses for no bill filtered by account.
      *
      * @param GenericRequest $request

app/Api/V1/Controllers/Insight/Expense/BudgetController.php

@@ -65,6 +65,9 @@ class BudgetController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseBudget
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -99,6 +102,9 @@ class BudgetController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoBudget
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Expense/CategoryController.php

@@ -66,6 +66,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -100,6 +103,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Expense/PeriodController.php

@@ -36,6 +36,9 @@ class PeriodController extends Controller
 {
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseTotal
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Expense/TagController.php

@@ -55,6 +55,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoTag
+     *
      * Expenses for no tag filtered by account.
      *
      * @param GenericRequest $request
@@ -105,6 +108,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightExpenseTag
+     *
      * Expenses per tag, possibly filtered by tag and account.
      *
      * @param GenericRequest $request

app/Api/V1/Controllers/Insight/Income/AccountController.php

@@ -73,6 +73,9 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeAsset
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -100,6 +103,9 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeRevenue
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Income/CategoryController.php

@@ -66,6 +66,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -100,6 +103,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeNoCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Income/PeriodController.php

@@ -36,6 +36,9 @@ class PeriodController extends Controller
 {
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeTotal
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Income/TagController.php

@@ -56,6 +56,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeTag
+     *
      * Expenses for no tag filtered by account.
      *
      * @param GenericRequest $request
@@ -108,6 +111,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightIncomeNoTag
+     *
      * Expenses per tag, possibly filtered by tag and account.
      *
      * @param GenericRequest $request

app/Api/V1/Controllers/Insight/Transfer/AccountController.php

@@ -58,6 +58,8 @@ class AccountController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransfers
      *
      * @param GenericRequest $request
      *
@@ -69,6 +71,7 @@ class AccountController extends Controller
         $end           = $request->getEnd();
         $assetAccounts = $request->getAssetAccounts();
         $transfers     = $this->opsRepository->sumTransfers($start, $end, $assetAccounts);
+
         return response()->json($transfers);
     }
 }

app/Api/V1/Controllers/Insight/Transfer/CategoryController.php

@@ -65,6 +65,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse
@@ -99,6 +102,9 @@ class CategoryController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoCategory
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Transfer/PeriodController.php

@@ -36,6 +36,9 @@ class PeriodController extends Controller
 {
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferTotal
+     *
      * @param GenericRequest $request
      *
      * @return JsonResponse

app/Api/V1/Controllers/Insight/Transfer/TagController.php

@@ -55,7 +55,8 @@ class TagController extends Controller
     }
 
     /**
-     * Expenses for no tag filtered by account.
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoTag
      *
      * @param GenericRequest $request
      *
@@ -107,6 +108,9 @@ class TagController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/insight/insightTransferTag
+     *
      * Transfers per tag, possibly filtered by tag and account.
      *
      * @param GenericRequest $request

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

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
@@ -144,7 +152,7 @@ class ListController extends Controller
      * @param Account $account
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      */
     public function transactions(Request $request, Account $account): JsonResponse
     {

app/Api/V1/Controllers/Models/Account/ShowController.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\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Support\Http\Api\AccountFilter;
@@ -65,12 +66,15 @@ 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
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(Request $request): JsonResponse
@@ -80,7 +84,7 @@ class ShowController extends Controller
         $this->parameters->set('type', $type);
 
         // types to get, page size:
-        $types    = $this->mapAccountTypes($this->parameters->get('type'));
+        $types = $this->mapAccountTypes($this->parameters->get('type'));
         $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
 
         // get list of accounts. Count it and split it.
@@ -91,7 +95,7 @@ class ShowController extends Controller
         // continue sort:
 
 
-        $accounts   = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        $accounts = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
         $paginator = new LengthAwarePaginator($accounts, $count, $pageSize, $this->parameters->get('page'));
@@ -108,6 +112,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/accounts/getAccount
+     *
      * Show single instance.
      *
      * @param Account $account

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

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
@@ -71,10 +74,10 @@ class UpdateController extends Controller
     public function update(UpdateRequest $request, Account $account): JsonResponse
     {
         Log::debug(sprintf('Now in %s', __METHOD__));
-        $data         = $request->getUpdateData();
+        $data = $request->getUpdateData();
         $data['type'] = config('firefly.shortNamesByFullName.' . $account->accountType->type);
-        $account      = $this->repository->update($account, $data);
+        $account = $this->repository->update($account, $data);
-        $manager      = $this->getManager();
+        $manager = $this->getManager();
         $account->refresh();
         Preferences::mark();
 

app/Api/V1/Controllers/Models/Attachment/DestroyController.php

@@ -49,7 +49,7 @@ class DestroyController extends Controller
         $this->middleware(
             function ($request, $next) {
                 /** @var User $user */
-                $user             = auth()->user();
+                $user = auth()->user();
                 $this->repository = app(AttachmentRepositoryInterface::class);
                 $this->repository->setUser($user);
 
@@ -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

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

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

app/Api/V1/Controllers/Models/Attachment/UpdateController.php

@@ -52,7 +52,7 @@ class UpdateController extends Controller
         $this->middleware(
             function ($request, $next) {
                 /** @var User $user */
-                $user             = auth()->user();
+                $user = auth()->user();
                 $this->repository = app(AttachmentRepositoryInterface::class);
                 $this->repository->setUser($user);
 
@@ -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

app/Api/V1/Controllers/Models/AvailableBudget/DestroyController.php

@@ -47,7 +47,7 @@ class DestroyController extends Controller
         $this->middleware(
             function ($request, $next) {
                 /** @var User $user */
-                $user               = auth()->user();
+                $user = auth()->user();
                 $this->abRepository = app(AvailableBudgetRepositoryInterface::class);
                 $this->abRepository->setUser($user);
 
@@ -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

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
@@ -98,6 +102,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/available_budgets/getAvailableBudget
+     *
      * Display the specified resource.
      *
      * @param AvailableBudget $availableBudget

app/Api/V1/Controllers/Models/AvailableBudget/StoreController.php

@@ -25,11 +25,13 @@ namespace FireflyIII\Api\V1\Controllers\Models\AvailableBudget;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\AvailableBudget\Request;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Factory\TransactionCurrencyFactory;
 use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
 use FireflyIII\Transformers\AvailableBudgetTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use JsonException;
 use League\Fractal\Resource\Item;
 
 /**
@@ -60,11 +62,16 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/available_budgets/storeAvailableBudget
+     *
      * Store a newly created resource in storage.
      *
      * @param Request $request
      *
      * @return JsonResponse
+     * @throws FireflyException
+     * @throws JsonException
      */
     public function store(Request $request): JsonResponse
     {

app/Api/V1/Controllers/Models/AvailableBudget/UpdateController.php

@@ -61,6 +61,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/available_budgets/updateAvailableBudget
+     *
      * Update the specified resource in storage.
      *
      * @param Request         $request

app/Api/V1/Controllers/Models/Bill/DestroyController.php

@@ -26,7 +26,6 @@ namespace FireflyIII\Api\V1\Controllers\Models\Bill;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -55,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/deleteBill
+     *
      * Remove the specified resource from storage.
      *
      * @param Bill $bill

app/Api/V1/Controllers/Models/Bill/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Bill;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
@@ -66,12 +67,15 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/listAttachmentByBill
+     *
      * Display a listing of the resource.
      *
      * @param Bill $bill
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(Bill $bill): JsonResponse
@@ -98,12 +102,15 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/listRuleByBill
+     *
      * List all of them.
      *
      * @param Bill $bill
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function rules(Bill $bill): JsonResponse
@@ -133,6 +140,9 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/listTransactionByBill
+     *
      * Show all transactions.
      *
      * @param Request $request
@@ -140,7 +150,7 @@ class ListController extends Controller
      * @param Bill    $bill
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Bill $bill): JsonResponse

app/Api/V1/Controllers/Models/Bill/ShowController.php

@@ -24,10 +24,10 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Bill;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Transformers\BillTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
@@ -60,10 +60,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/listBill
+     *
      * Display a listing of the resource.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -87,6 +90,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/getBill
+     *
      * Show the specified bill.
      *
      * @param Bill $bill

app/Api/V1/Controllers/Models/Bill/StoreController.php

@@ -29,7 +29,6 @@ use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
 use FireflyIII\Transformers\BillTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -61,6 +60,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/storeBill
+     *
      * Store a bill.
      *
      * @param StoreRequest $request
@@ -70,8 +72,8 @@ class StoreController extends Controller
      */
     public function store(StoreRequest $request): JsonResponse
     {
-        $data    = $request->getAll();
+        $data = $request->getAll();
-        $bill    = $this->repository->store($data);
+        $bill = $this->repository->store($data);
         $manager = $this->getManager();
 
         /** @var BillTransformer $transformer */

app/Api/V1/Controllers/Models/Bill/UpdateController.php

@@ -28,7 +28,6 @@ use FireflyIII\Api\V1\Requests\Models\Bill\UpdateRequest;
 use FireflyIII\Models\Bill;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Transformers\BillTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -58,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/bills/updateBill
+     *
      * Update a bill.
      *
      * @param UpdateRequest $request
@@ -67,8 +69,8 @@ class UpdateController extends Controller
      */
     public function update(UpdateRequest $request, Bill $bill): JsonResponse
     {
-        $data    = $request->getAll();
+        $data = $request->getAll();
-        $bill    = $this->repository->update($bill, $data);
+        $bill = $this->repository->update($bill, $data);
         $manager = $this->getManager();
 
         /** @var BillTransformer $transformer */

app/Api/V1/Controllers/Models/Budget/DestroyController.php

@@ -54,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/deleteBudget
+     *
      * Remove the specified resource from storage.
      *
      * @param Budget $budget

app/Api/V1/Controllers/Models/Budget/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Budget;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
@@ -70,10 +71,13 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listAttachmentByBudget
+     *
      * @param Budget $budget
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(Budget $budget): JsonResponse
@@ -100,12 +104,15 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listBudgetLimitByBudget
+     *
      * Display a listing of the resource.
      *
      * @param Budget $budget
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function budgetLimits(Budget $budget): JsonResponse
@@ -129,6 +136,9 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listTransactionByBudget
+     *
      * Show all transactions.
      *
      * @param Request $request
@@ -136,7 +146,7 @@ class ListController extends Controller
      * @param Budget  $budget
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Budget $budget): JsonResponse

app/Api/V1/Controllers/Models/Budget/ShowController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Budget;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
 use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
@@ -52,7 +53,7 @@ class ShowController extends Controller
         parent::__construct();
         $this->middleware(
             function ($request, $next) {
-                $this->repository   = app(BudgetRepositoryInterface::class);
+                $this->repository = app(BudgetRepositoryInterface::class);
                 $this->blRepository = app(BudgetLimitRepositoryInterface::class);
                 $this->repository->setUser(auth()->user());
                 $this->blRepository->setUser(auth()->user());
@@ -63,10 +64,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listBudget
+     *
      * Display a listing of the resource.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse

app/Api/V1/Controllers/Models/Budget/StoreController.php

@@ -57,6 +57,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/storeBudget
+     *
      * Store a budget.
      *
      * @param StoreRequest $request

app/Api/V1/Controllers/Models/Budget/UpdateController.php

@@ -57,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/updateBudget
+     *
      * Update a budget.
      *
      * @param UpdateRequest $request

app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php

@@ -59,6 +59,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/deleteBudgetLimit
+     *
      * Remove the specified resource from storage.
      *
      * @param Budget      $budget

app/Api/V1/Controllers/Models/BudgetLimit/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\BudgetLimit;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Budget;
 use FireflyIII\Models\BudgetLimit;
@@ -66,6 +67,8 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listTransactionByBudgetLimit
      * Show all transactions.
      *
      * @param Request     $request
@@ -73,7 +76,7 @@ class ListController extends Controller
      * @param BudgetLimit $budgetLimit
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Budget $budget, BudgetLimit $budgetLimit): JsonResponse

app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php

@@ -70,7 +70,10 @@ class ShowController extends Controller
     }
 
     /**
-     * Display a listing of the budget limits for this budget..
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listBudgetLimitByBudget
+     *
+     * Display a listing of the budget limits for this budget.
      *
      * @param Request $request
      * @param Budget  $budget
@@ -101,7 +104,10 @@ class ShowController extends Controller
     }
 
     /**
-     * Display a listing of the budget limits for this budget..
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/listBudgetLimit
+     *
+     * Display a listing of the budget limits for this budget.
      *
      * @param DateRequest $request
      *
@@ -131,6 +137,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/getBudgetLimit
+     *
      * @param Request     $request
      * @param Budget      $budget
      * @param BudgetLimit $budgetLimit

app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php

@@ -25,7 +25,6 @@ namespace FireflyIII\Api\V1\Controllers\Models\BudgetLimit;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\BudgetLimit\StoreRequest;
-use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Budget;
 use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
 use FireflyIII\Transformers\BudgetLimitTransformer;
@@ -61,6 +60,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/storeBudgetLimit
+     *
      * Store a newly created resource in storage.
      *
      * @param StoreRequest $request

app/Api/V1/Controllers/Models/BudgetLimit/UpdateController.php

@@ -42,6 +42,9 @@ class UpdateController extends Controller
     private BudgetLimitRepositoryInterface $blRepository;
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/budgets/updateBudgetLimit
+     *
      * BudgetLimitController constructor.
      *
      * @codeCoverageIgnore

app/Api/V1/Controllers/Models/Category/DestroyController.php

@@ -26,7 +26,6 @@ namespace FireflyIII\Api\V1\Controllers\Models\Category;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Models\Category;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -55,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/deleteCategory
+     *
      * Remove the specified resource from storage.
      *
      * @param Category $category

app/Api/V1/Controllers/Models/Category/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Category;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Category;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
@@ -65,10 +66,13 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/listAttachmentByCategory
+     *
      * @param Category $category
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(Category $category): JsonResponse
@@ -95,6 +99,9 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/listTransactionByCategory
+     *
      * Show all transactions.
      *
      * @param Request  $request
@@ -102,7 +109,7 @@ class ListController extends Controller
      * @param Category $category
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Category $category): JsonResponse

app/Api/V1/Controllers/Models/Category/ShowController.php

@@ -24,10 +24,10 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Category;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Category;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
 use FireflyIII\Transformers\CategoryTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
@@ -60,10 +60,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/listCategory
+     *
      * Display a listing of the resource.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -92,6 +95,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/getCategory
+     *
      * Show the category.
      *
      * @param Category $category

app/Api/V1/Controllers/Models/Category/StoreController.php

@@ -28,7 +28,6 @@ use FireflyIII\Api\V1\Requests\Models\Category\StoreRequest;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
 use FireflyIII\Transformers\CategoryTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -58,6 +57,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/storeCategory
+     *
      * Store new category.
      *
      * @param StoreRequest $request

app/Api/V1/Controllers/Models/Category/UpdateController.php

@@ -28,7 +28,6 @@ use FireflyIII\Api\V1\Requests\Models\Category\UpdateRequest;
 use FireflyIII\Models\Category;
 use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
 use FireflyIII\Transformers\CategoryTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -58,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/categories/updateCategory
+     *
      * Update the category.
      *
      * @param UpdateRequest $request
@@ -67,9 +69,9 @@ class UpdateController extends Controller
      */
     public function update(UpdateRequest $request, Category $category): JsonResponse
     {
-        $data     = $request->getAll();
+        $data = $request->getAll();
         $category = $this->repository->update($category, $data);
-        $manager  = $this->getManager();
+        $manager = $this->getManager();
 
         /** @var CategoryTransformer $transformer */
         $transformer = app(CategoryTransformer::class);

app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php

@@ -47,7 +47,7 @@ class DestroyController extends Controller
         $this->middleware(
             function ($request, $next) {
                 /** @var User $user */
-                $user             = auth()->user();
+                $user = auth()->user();
                 $this->repository = app(ObjectGroupRepositoryInterface::class);
                 $this->repository->setUser($user);
 
@@ -57,6 +57,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/deleteObjectGroup
+     *
      * Remove the specified resource from storage.
      *
      * @param ObjectGroup $objectGroup

app/Api/V1/Controllers/Models/ObjectGroup/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\ObjectGroup;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\ObjectGroup;
 use FireflyIII\Repositories\ObjectGroup\ObjectGroupRepositoryInterface;
 use FireflyIII\Transformers\BillTransformer;
@@ -52,7 +53,7 @@ class ListController extends Controller
         $this->middleware(
             function ($request, $next) {
                 /** @var User $user */
-                $user             = auth()->user();
+                $user = auth()->user();
                 $this->repository = app(ObjectGroupRepositoryInterface::class);
                 $this->repository->setUser($user);
 
@@ -62,12 +63,15 @@ class ListController extends Controller
     }
 
     /**
-     * List all bills
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/listBillByObjectGroup
+     *
+     * List all bills in this object group
      *
      * @param ObjectGroup $objectGroup
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function bills(ObjectGroup $objectGroup): JsonResponse
@@ -95,12 +99,15 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/listPiggyBankByObjectGroup
+     *
      * List all piggies under the object group.
      *
      * @param ObjectGroup $objectGroup
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function piggyBanks(ObjectGroup $objectGroup): JsonResponse

app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\ObjectGroup;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\ObjectGroup;
 use FireflyIII\Repositories\ObjectGroup\ObjectGroupRepositoryInterface;
 use FireflyIII\Transformers\ObjectGroupTransformer;
@@ -63,12 +64,15 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/listObjectGroups
+     *
      * Display a listing of the resource.
      *
      * @param Request $request
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(Request $request): JsonResponse
@@ -98,6 +102,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/getObjectGroup
+     *
      * Show single instance.
      *
      * @param ObjectGroup $objectGroup

app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php

@@ -50,7 +50,7 @@ class UpdateController extends Controller
         $this->middleware(
             function ($request, $next) {
                 /** @var User $user */
-                $user             = auth()->user();
+                $user = auth()->user();
                 $this->repository = app(ObjectGroupRepositoryInterface::class);
                 $this->repository->setUser($user);
 
@@ -60,6 +60,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/object_groups/updateObjectGroup
+     *
      * @param UpdateRequest $request
      * @param ObjectGroup   $objectGroup
      *

app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php

@@ -54,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/deletePiggyBank
+     *
      * Delete the resource.
      *
      * @param PiggyBank $piggyBank

app/Api/V1/Controllers/Models/PiggyBank/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\PiggyBank;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\PiggyBank;
 use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
 use FireflyIII\Transformers\AttachmentTransformer;
@@ -59,10 +60,13 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/listAttachmentByPiggyBank
+     *
      * @param PiggyBank $piggyBank
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(PiggyBank $piggyBank): JsonResponse
@@ -89,12 +93,15 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/listEventByPiggyBank
+     *
      * List single resource.
      *
      * @param PiggyBank $piggyBank
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function piggyBankEvents(PiggyBank $piggyBank): JsonResponse

app/Api/V1/Controllers/Models/PiggyBank/ShowController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\PiggyBank;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\PiggyBank;
 use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
 use FireflyIII\Transformers\PiggyBankTransformer;
@@ -59,10 +60,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/listPiggyBank
+     *
      * List all of them.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -92,6 +96,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/getPiggyBank
+     *
      * List single resource.
      *
      * @param PiggyBank $piggyBank

app/Api/V1/Controllers/Models/PiggyBank/StoreController.php

@@ -57,6 +57,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/storePiggyBank
+     *
      * Store new object.
      *
      * @param StoreRequest $request

app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php

@@ -57,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/piggy_banks/updatePiggyBank
+     *
      * Update piggy bank.
      *
      * @param UpdateRequest $request
@@ -66,7 +69,7 @@ class UpdateController extends Controller
      */
     public function update(UpdateRequest $request, PiggyBank $piggyBank): JsonResponse
     {
-        $data      = $request->getAll();
+        $data = $request->getAll();
         $piggyBank = $this->repository->update($piggyBank, $data);
 
         if (array_key_exists('current_amount', $data) && '' !== $data['current_amount']) {

app/Api/V1/Controllers/Models/Recurrence/DestroyController.php

@@ -26,7 +26,6 @@ namespace FireflyIII\Api\V1\Controllers\Models\Recurrence;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Models\Recurrence;
 use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -55,6 +54,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/recurrences/deleteRecurrence
+     *
      * Delete the resource.
      *
      * @param Recurrence $recurrence

app/Api/V1/Controllers/Models/Recurrence/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Recurrence;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Recurrence;
 use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
@@ -63,13 +64,16 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/recurrences/listTransactionByRecurrence
+     *
      * Show transactions for this recurrence.
      *
      * @param Request    $request
      * @param Recurrence $recurrence
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Recurrence $recurrence): JsonResponse

app/Api/V1/Controllers/Models/Recurrence/ShowController.php

@@ -24,10 +24,10 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Recurrence;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Recurrence;
 use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
 use FireflyIII\Transformers\RecurrenceTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
@@ -60,10 +60,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/recurrences/listRecurrence
+     *
      * List all of them.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -94,6 +97,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/recurrences/getRecurrence
+     *
      * List single resource.
      *
      * @param Recurrence $recurrence

app/Api/V1/Controllers/Models/Recurrence/StoreController.php

@@ -28,7 +28,6 @@ use FireflyIII\Api\V1\Requests\Models\Recurrence\StoreRequest;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
 use FireflyIII\Transformers\RecurrenceTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -58,6 +57,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/recurrences/storeRecurrence
+     *
      * Store new object.
      *
      * @param StoreRequest $request
@@ -67,9 +69,9 @@ class StoreController extends Controller
      */
     public function store(StoreRequest $request): JsonResponse
     {
-        $data       = $request->getAll();
+        $data = $request->getAll();
         $recurrence = $this->repository->store($data);
-        $manager    = $this->getManager();
+        $manager = $this->getManager();
 
         /** @var RecurrenceTransformer $transformer */
         $transformer = app(RecurrenceTransformer::class);

app/Api/V1/Controllers/Models/Recurrence/UpdateController.php

@@ -28,7 +28,6 @@ use FireflyIII\Api\V1\Requests\Models\Recurrence\UpdateRequest;
 use FireflyIII\Models\Recurrence;
 use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
 use FireflyIII\Transformers\RecurrenceTransformer;
-use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -58,6 +57,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/recurrences/updateRecurrence
+     *
      * Update single recurrence.
      *
      * @param UpdateRequest $request
@@ -67,9 +69,9 @@ class UpdateController extends Controller
      */
     public function update(UpdateRequest $request, Recurrence $recurrence): JsonResponse
     {
-        $data       = $request->getAll();
+        $data = $request->getAll();
         $recurrence = $this->repository->update($recurrence, $data);
-        $manager    = $this->getManager();
+        $manager = $this->getManager();
 
         /** @var RecurrenceTransformer $transformer */
         $transformer = app(RecurrenceTransformer::class);

app/Api/V1/Controllers/Models/Rule/DestroyController.php

@@ -58,6 +58,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rules/deleteRule
+     *
      * Delete the resource.
      *
      * @param Rule $rule

app/Api/V1/Controllers/Models/Rule/ShowController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Rule;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Rule;
 use FireflyIII\Repositories\Rule\RuleRepositoryInterface;
 use FireflyIII\Transformers\RuleTransformer;
@@ -63,10 +64,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rules/listRule
+     *
      * List all of them.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -97,6 +101,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rules/getRule
+     *
      * List single resource.
      *
      * @param Rule $rule

app/Api/V1/Controllers/Models/Rule/StoreController.php

@@ -60,6 +60,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rules/storeRule
+     *
      * Store new object.
      *
      * @param StoreRequest $request
@@ -68,7 +71,7 @@ class StoreController extends Controller
      */
     public function store(StoreRequest $request): JsonResponse
     {
-        $rule    = $this->ruleRepository->store($request->getAll());
+        $rule = $this->ruleRepository->store($request->getAll());
         $manager = $this->getManager();
         /** @var RuleTransformer $transformer */
         $transformer = app(RuleTransformer::class);

app/Api/V1/Controllers/Models/Rule/TriggerController.php

@@ -66,6 +66,9 @@ class TriggerController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rules/testRule
+     *
      * @param TestRequest $request
      * @param Rule        $rule
      *
@@ -113,6 +116,9 @@ class TriggerController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rules/fireRule
+     *
      * Execute the given rule group on a set of existing transactions.
      *
      * @param TriggerRequest $request

app/Api/V1/Controllers/Models/Rule/UpdateController.php

@@ -61,6 +61,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rules/updateRule
+     *
      * Update a rule.
      *
      * @param UpdateRequest $request
@@ -70,8 +73,8 @@ class UpdateController extends Controller
      */
     public function update(UpdateRequest $request, Rule $rule): JsonResponse
     {
-        $data    = $request->getAll();
+        $data = $request->getAll();
-        $rule    = $this->ruleRepository->update($rule, $data);
+        $rule = $this->ruleRepository->update($rule, $data);
         $manager = $this->getManager();
 
         /** @var RuleTransformer $transformer */

app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php

@@ -58,6 +58,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rule_groups/deleteRuleGroup
+     *
      * Delete the resource.
      *
      * @param RuleGroup $ruleGroup

app/Api/V1/Controllers/Models/RuleGroup/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\RuleGroup;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\RuleGroup;
 use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
 use FireflyIII\Transformers\RuleTransformer;
@@ -62,10 +63,13 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rule_groups/listRuleByGroup
+     *
      * @param RuleGroup $group
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function rules(RuleGroup $group): JsonResponse

app/Api/V1/Controllers/Models/RuleGroup/ShowController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\RuleGroup;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\RuleGroup;
 use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
 use FireflyIII\Transformers\RuleGroupTransformer;
@@ -63,10 +64,12 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rule_groups/listRuleGroup
      * List all of them.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -95,6 +98,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rule_groups/getRuleGroup
+     *
      * List single resource.
      *
      * @param RuleGroup $ruleGroup

app/Api/V1/Controllers/Models/RuleGroup/StoreController.php

@@ -38,7 +38,7 @@ use League\Fractal\Resource\Item;
 class StoreController extends Controller
 {
 
-    private AccountRepositoryInterface   $accountRepository;
+    private AccountRepositoryInterface $accountRepository;
     private RuleGroupRepositoryInterface $ruleGroupRepository;
 
     /**
@@ -66,6 +66,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rule_groups/storeRuleGroup
+     *
      * Store new object.
      *
      * @param StoreRequest $request

app/Api/V1/Controllers/Models/RuleGroup/TriggerController.php

@@ -23,6 +23,7 @@ declare(strict_types=1);
 
 namespace FireflyIII\Api\V1\Controllers\Models\RuleGroup;
 
+use Exception;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\RuleGroup\TestRequest;
 use FireflyIII\Api\V1\Requests\Models\RuleGroup\TriggerRequest;
@@ -34,10 +35,8 @@ use FireflyIII\Transformers\TransactionGroupTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
-use Illuminate\Support\Collection;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
-use Exception;
 
 /**
  * Class TriggerController
@@ -68,6 +67,9 @@ class TriggerController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rule_groups/testRuleGroup
+     *
      * @param TestRequest $request
      * @param RuleGroup   $group
      *
@@ -121,6 +123,9 @@ class TriggerController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rule_groups/fireRuleGroup
+     *
      * Execute the given rule group on a set of existing transactions.
      *
      * @param TriggerRequest $request

app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php

@@ -62,6 +62,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This is endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/rule_groups/updateRuleGroup
+     *
      * Update a rule group.
      *
      * @param UpdateRequest $request

app/Api/V1/Controllers/Models/Tag/DestroyController.php

@@ -58,6 +58,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/tags/deleteTag
+     *
      * Delete the resource.
      *
      * @param Tag $tag

app/Api/V1/Controllers/Models/Tag/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Tag;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Tag;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
@@ -68,10 +69,13 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/tags/listAttachmentByTag
+     *
      * @param Tag $tag
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(Tag $tag): JsonResponse
@@ -98,13 +102,16 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/tags/listTransactionByTag
+     *
      * Show all transactions.
      *
      * @param Request $request
      * @param Tag     $tag
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactions(Request $request, Tag $tag): JsonResponse

app/Api/V1/Controllers/Models/Tag/ShowController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Tag;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Tag;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
 use FireflyIII\Transformers\TagTransformer;
@@ -63,10 +64,13 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/tags/listTag
+     *
      * List all of them.
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
@@ -95,6 +99,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/tags/getTag
+     *
      * List single resource.
      *
      * @param Tag $tag

app/Api/V1/Controllers/Models/Tag/StoreController.php

@@ -60,6 +60,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/tags/storeTag
+     *
      * Store new object.
      *
      * @param StoreRequest $request
@@ -68,7 +71,7 @@ class StoreController extends Controller
      */
     public function store(StoreRequest $request): JsonResponse
     {
-        $rule    = $this->repository->store($request->getAll());
+        $rule = $this->repository->store($request->getAll());
         $manager = $this->getManager();
         /** @var TagTransformer $transformer */
         $transformer = app(TagTransformer::class);

app/Api/V1/Controllers/Models/Tag/UpdateController.php

@@ -61,6 +61,9 @@ class UpdateController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/tags/updateTag
+     *
      * Update a rule.
      *
      * @param UpdateRequest $request
@@ -70,7 +73,7 @@ class UpdateController extends Controller
      */
     public function update(UpdateRequest $request, Tag $tag): JsonResponse
     {
-        $rule    = $this->repository->update($tag, $request->getAll());
+        $rule = $this->repository->update($tag, $request->getAll());
         $manager = $this->getManager();
         /** @var TagTransformer $transformer */
         $transformer = app(TagTransformer::class);

app/Api/V1/Controllers/Models/Transaction/DestroyController.php

@@ -60,6 +60,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/deleteTransaction
+     *
      * Remove the specified resource from storage.
      *
      * @param TransactionGroup $transactionGroup
@@ -77,6 +80,9 @@ class DestroyController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/deleteTransactionJournal
+     *
      * Remove the specified resource from storage.
      *
      * @param TransactionJournal $transactionJournal

app/Api/V1/Controllers/Models/Transaction/ListController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Transaction;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\TransactionGroup;
 use FireflyIII\Models\TransactionJournal;
 use FireflyIII\Repositories\Journal\JournalAPIRepositoryInterface;
@@ -66,10 +67,13 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/listAttachmentByTransaction
+     *
      * @param TransactionGroup $transactionGroup
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function attachments(TransactionGroup $transactionGroup): JsonResponse
@@ -99,10 +103,13 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/listEventByTransaction
+     *
      * @param TransactionGroup $transactionGroup
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function piggyBankEvents(TransactionGroup $transactionGroup): JsonResponse
@@ -135,10 +142,13 @@ class ListController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/listLinksByJournal
+     *
      * @param TransactionJournal $transactionJournal
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function transactionLinks(TransactionJournal $transactionJournal): JsonResponse

app/Api/V1/Controllers/Models/Transaction/ShowController.php

@@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers\Models\Transaction;
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\TransactionGroup;
 use FireflyIII\Models\TransactionJournal;
@@ -45,12 +46,15 @@ class ShowController extends Controller
     use TransactionFilter;
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/listTransaction
+     *
      * Show all transactions.
      *
      * @param Request $request
      *
      * @return JsonResponse
-     * @throws \FireflyIII\Exceptions\FireflyException
+     * @throws FireflyException
      * @codeCoverageIgnore
      */
     public function index(Request $request): JsonResponse
@@ -95,6 +99,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/getTransactionByJournal
+     *
      * Show a single transaction, by transaction journal.
      *
      * @param TransactionJournal $transactionJournal
@@ -108,6 +115,9 @@ class ShowController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/getTransaction
+     *
      * Show a single transaction.
      *
      * @param TransactionGroup $transactionGroup

app/Api/V1/Controllers/Models/Transaction/StoreController.php

@@ -71,6 +71,9 @@ class StoreController extends Controller
     }
 
     /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/#/transactions/storeTransaction
+     *
      * Store a new transaction.
      *
      * @param StoreRequest $request
@@ -94,16 +97,16 @@ class StoreController extends Controller
             $validator = Validator::make(
                 ['transactions' => [['description' => $e->getMessage()]]], ['transactions.0.description' => new IsDuplicateTransaction]
             );
-            throw new ValidationException($validator,0, $e);
+            throw new ValidationException($validator, 0, $e);
         } catch (FireflyException $e) {
             Log::warning('Caught an exception. Return error message.');
             Log::error($e->getMessage());
             $message   = sprintf('Internal exception: %s', $e->getMessage());
             $validator = Validator::make(['transactions' => [['description' => $message]]], ['transactions.0.description' => new IsDuplicateTransaction]);
-            throw new ValidationException($validator,0, $e);
+            throw new ValidationException($validator, 0, $e);
         }
         app('preferences')->mark();
-        $applyRules = $data['apply_rules'] ?? true;
+        $applyRules   = $data['apply_rules'] ?? true;
         $fireWebhooks = $data['fire_webhooks'] ?? true;
         event(new StoredTransactionGroup($transactionGroup, $applyRules, $fireWebhooks));