diff --git a/app/Api/V1/Controllers/Data/DestroyController.php b/app/Api/V1/Controllers/Data/DestroyController.php index df724abe71..adba823dbc 100644 --- a/app/Api/V1/Controllers/Data/DestroyController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Data/Export/ExportController.php b/app/Api/V1/Controllers/Data/Export/ExportController.php index 72786554b4..4eb6343b41 100644 --- a/app/Api/V1/Controllers/Data/Export/ExportController.php +++ b/app/Api/V1/Controllers/Data/Export/ExportController.php @@ -26,9 +26,11 @@ 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; +use League\Csv\Exception; /** * Class ExportController @@ -54,10 +56,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,9 +76,7 @@ class ExportController extends Controller * @param string $key * * @return LaravelResponse - * @throws CannotInsertRecord - * @throws \FireflyIII\Exceptions\FireflyException - * @throws \League\Csv\Exception + * @throws FireflyException */ private function returnExport(string $key): LaravelResponse { @@ -98,10 +101,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 +117,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 +133,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 +149,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 +165,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 +181,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 +197,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 +213,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 { diff --git a/app/Api/V1/Controllers/Insight/Expense/AccountController.php b/app/Api/V1/Controllers/Insight/Expense/AccountController.php index 03d3c2418d..af32ae9e60 100644 --- a/app/Api/V1/Controllers/Insight/Expense/AccountController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Expense/BillController.php b/app/Api/V1/Controllers/Insight/Expense/BillController.php index c73cc8e1b8..e79633d264 100644 --- a/app/Api/V1/Controllers/Insight/Expense/BillController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Expense/BudgetController.php b/app/Api/V1/Controllers/Insight/Expense/BudgetController.php index e21d072fff..dac96322a7 100644 --- a/app/Api/V1/Controllers/Insight/Expense/BudgetController.php +++ b/app/Api/V1/Controllers/Insight/Expense/BudgetController.php @@ -65,6 +65,9 @@ class BudgetController extends Controller } /** + * This endpoint is documented at: + * http://10.0.0.15/FF3/api/api-docs/#/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 diff --git a/app/Api/V1/Controllers/Insight/Expense/CategoryController.php b/app/Api/V1/Controllers/Insight/Expense/CategoryController.php index c32e800655..db8f31a2c3 100644 --- a/app/Api/V1/Controllers/Insight/Expense/CategoryController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Expense/PeriodController.php b/app/Api/V1/Controllers/Insight/Expense/PeriodController.php index ec06e0436b..a83f6ca66a 100644 --- a/app/Api/V1/Controllers/Insight/Expense/PeriodController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Expense/TagController.php b/app/Api/V1/Controllers/Insight/Expense/TagController.php index d9e16fba55..d856d01c3d 100644 --- a/app/Api/V1/Controllers/Insight/Expense/TagController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Income/AccountController.php b/app/Api/V1/Controllers/Insight/Income/AccountController.php index 30e6b3a9e5..719a77ab6c 100644 --- a/app/Api/V1/Controllers/Insight/Income/AccountController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Income/CategoryController.php b/app/Api/V1/Controllers/Insight/Income/CategoryController.php index ffc84536fb..47007f432f 100644 --- a/app/Api/V1/Controllers/Insight/Income/CategoryController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Income/PeriodController.php b/app/Api/V1/Controllers/Insight/Income/PeriodController.php index f443cdc81d..4ec6c12acb 100644 --- a/app/Api/V1/Controllers/Insight/Income/PeriodController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Income/TagController.php b/app/Api/V1/Controllers/Insight/Income/TagController.php index 37eb525a60..8e58fbf01d 100644 --- a/app/Api/V1/Controllers/Insight/Income/TagController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Transfer/AccountController.php b/app/Api/V1/Controllers/Insight/Transfer/AccountController.php index f20716ab84..141daf143e 100644 --- a/app/Api/V1/Controllers/Insight/Transfer/AccountController.php +++ b/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 * diff --git a/app/Api/V1/Controllers/Insight/Transfer/CategoryController.php b/app/Api/V1/Controllers/Insight/Transfer/CategoryController.php index b575bbc93a..43b77675ed 100644 --- a/app/Api/V1/Controllers/Insight/Transfer/CategoryController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Transfer/PeriodController.php b/app/Api/V1/Controllers/Insight/Transfer/PeriodController.php index dfa12c7132..ecb42d4a9f 100644 --- a/app/Api/V1/Controllers/Insight/Transfer/PeriodController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Insight/Transfer/TagController.php b/app/Api/V1/Controllers/Insight/Transfer/TagController.php index e67b01ac9c..59404dcbbb 100644 --- a/app/Api/V1/Controllers/Insight/Transfer/TagController.php +++ b/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