IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update various endpoints.

Browse Source
This commit is contained in:
James Cole 2021-09-18 05:58:22 +02:00
parent 190b6fb25f
commit 4f27ca28c3
No known key found for this signature in database
GPG Key ID: BDE6667570EADBD5
16 changed files with 113 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
app/Api/V1/Controllers/Data/DestroyController.php
View File

@ -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

51
app/Api/V1/Controllers/Data/Export/ExportController.php
View File

@ -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
{

8
app/Api/V1/Controllers/Insight/Expense/AccountController.php
View File

@ -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

6
app/Api/V1/Controllers/Insight/Expense/BillController.php
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.
*
* @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

6
app/Api/V1/Controllers/Insight/Expense/BudgetController.php
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
*
* @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

6
app/Api/V1/Controllers/Insight/Expense/CategoryController.php
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
*
* @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

3
app/Api/V1/Controllers/Insight/Expense/PeriodController.php
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
*
* @return JsonResponse

6
app/Api/V1/Controllers/Insight/Expense/TagController.php
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.
*
* @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

6
app/Api/V1/Controllers/Insight/Income/AccountController.php
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
*
* @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

6
app/Api/V1/Controllers/Insight/Income/CategoryController.php
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
*
* @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

3
app/Api/V1/Controllers/Insight/Income/PeriodController.php
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
*
* @return JsonResponse

6
app/Api/V1/Controllers/Insight/Income/TagController.php
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.
*
* @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

2
app/Api/V1/Controllers/Insight/Transfer/AccountController.php
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
*

6
app/Api/V1/Controllers/Insight/Transfer/CategoryController.php
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
*
* @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

3
app/Api/V1/Controllers/Insight/Transfer/PeriodController.php
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
*
* @return JsonResponse

6
app/Api/V1/Controllers/Insight/Transfer/TagController.php
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
*
@ -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