Update various endpoints.

This commit is contained in:
James Cole
2021-09-18 05:58:22 +02:00
parent 190b6fb25f
commit 4f27ca28c3
16 changed files with 113 additions and 14 deletions

View File

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

View File

@@ -26,9 +26,11 @@ namespace FireflyIII\Api\V1\Controllers\Data\Export;
use FireflyIII\Api\V1\Controllers\Controller; use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Api\V1\Requests\Data\Export\ExportRequest; use FireflyIII\Api\V1\Requests\Data\Export\ExportRequest;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Support\Export\ExportDataGenerator; use FireflyIII\Support\Export\ExportDataGenerator;
use Illuminate\Http\Response as LaravelResponse; use Illuminate\Http\Response as LaravelResponse;
use League\Csv\CannotInsertRecord; use League\Csv\CannotInsertRecord;
use League\Csv\Exception;
/** /**
* Class ExportController * 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function accounts(ExportRequest $request): LaravelResponse public function accounts(ExportRequest $request): LaravelResponse
{ {
@@ -71,9 +76,7 @@ class ExportController extends Controller
* @param string $key * @param string $key
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
* @throws \FireflyIII\Exceptions\FireflyException
* @throws \League\Csv\Exception
*/ */
private function returnExport(string $key): LaravelResponse 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function bills(ExportRequest $request): LaravelResponse 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function budgets(ExportRequest $request): LaravelResponse 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function categories(ExportRequest $request): LaravelResponse 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function piggyBanks(ExportRequest $request): LaravelResponse 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function recurring(ExportRequest $request): LaravelResponse 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function rules(ExportRequest $request): LaravelResponse 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function tags(ExportRequest $request): LaravelResponse 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 * @param ExportRequest $request
* *
* @return LaravelResponse * @return LaravelResponse
* @throws CannotInsertRecord * @throws FireflyException
*/ */
public function transactions(ExportRequest $request): LaravelResponse public function transactions(ExportRequest $request): LaravelResponse
{ {

View File

@@ -37,7 +37,7 @@ use Illuminate\Http\JsonResponse;
* Class AccountController * Class AccountController
* *
* Shows expense information grouped or limited by date. * 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 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 * @param GenericRequest $request
* *
* @return JsonResponse * @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 * @param GenericRequest $request
* *
* @return JsonResponse * @return JsonResponse

View File

@@ -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. * Expenses per bill, possibly filtered by bill and account.
* *
* @param GenericRequest $request * @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. * Expenses for no bill filtered by account.
* *
* @param GenericRequest $request * @param GenericRequest $request

View File

@@ -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 * @param GenericRequest $request
* *
* @return JsonResponse * @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 * @param GenericRequest $request
* *
* @return JsonResponse * @return JsonResponse

View File

@@ -66,6 +66,9 @@ class CategoryController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/insight/insightTransferCategory
*
* @param GenericRequest $request * @param GenericRequest $request
* *
* @return JsonResponse * @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 * @param GenericRequest $request
* *
* @return JsonResponse * @return JsonResponse

View File

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

View File

@@ -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. * Expenses for no tag filtered by account.
* *
* @param GenericRequest $request * @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. * Expenses per tag, possibly filtered by tag and account.
* *
* @param GenericRequest $request * @param GenericRequest $request

View File

@@ -73,6 +73,9 @@ class AccountController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/insight/insightIncomeAsset
*
* @param GenericRequest $request * @param GenericRequest $request
* *
* @return JsonResponse * @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 * @param GenericRequest $request
* *
* @return JsonResponse * @return JsonResponse

View File

@@ -66,6 +66,9 @@ class CategoryController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/insight/insightIncomeCategory
*
* @param GenericRequest $request * @param GenericRequest $request
* *
* @return JsonResponse * @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 * @param GenericRequest $request
* *
* @return JsonResponse * @return JsonResponse

View File

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

View File

@@ -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. * Expenses for no tag filtered by account.
* *
* @param GenericRequest $request * @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. * Expenses per tag, possibly filtered by tag and account.
* *
* @param GenericRequest $request * @param GenericRequest $request

View File

@@ -58,6 +58,8 @@ class AccountController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/insight/insightTransfers
* *
* @param GenericRequest $request * @param GenericRequest $request
* *

View File

@@ -65,6 +65,9 @@ class CategoryController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/insight/insightTransferCategory
*
* @param GenericRequest $request * @param GenericRequest $request
* *
* @return JsonResponse * @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 * @param GenericRequest $request
* *
* @return JsonResponse * @return JsonResponse

View File

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

View File

@@ -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 * @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. * Transfers per tag, possibly filtered by tag and account.
* *
* @param GenericRequest $request * @param GenericRequest $request