Clean up some API endpoints.

2025-02-25 18:45:27 -06:00 · 2021-03-03 07:02:57 +01:00 · 2021-03-03 07:02:57 +01:00 · df9c9ce044
commit df9c9ce044
parent 1f12d81008
6 changed files with 86 additions and 102 deletions
--- a/app/Api/V1/Controllers/Chart/AccountController.php
+++ b/app/Api/V1/Controllers/Chart/AccountController.php
@ -73,7 +73,7 @@ class AccountController extends Controller

    /**
     * @param DateRequest $request
-     *
+     * @deprecated
     * @return JsonResponse
     */
    public function expenseOverview(DateRequest $request): JsonResponse
@ -223,7 +223,7 @@ class AccountController extends Controller

    /**
     * @param DateRequest $request
-     *
+     * @deprecated
     * @return JsonResponse
     */
    public function revenueOverview(DateRequest $request): JsonResponse
--- a/app/Api/V1/Controllers/Chart/AvailableBudgetController.php
+++ b/app/Api/V1/Controllers/Chart/AvailableBudgetController.php
@ -42,7 +42,7 @@ class AvailableBudgetController extends Controller

    /**
     * AvailableBudgetController constructor.
-     *
+     * @deprecated
     * @codeCoverageIgnore
     */
    public function __construct()
@ -64,7 +64,7 @@ class AvailableBudgetController extends Controller

    /**
     * @param AvailableBudget $availableBudget
-     *
+     * @deprecated
     * @return JsonResponse
     */
    public function overview(AvailableBudget $availableBudget): JsonResponse
--- a/app/Api/V1/Controllers/Chart/BudgetController.php
+++ b/app/Api/V1/Controllers/Chart/BudgetController.php
@ -49,7 +49,7 @@ class BudgetController extends Controller

    /**
     * BudgetController constructor.
-     *
+     * @deprecated
     * @codeCoverageIgnore
     */
    public function __construct()
@ -80,7 +80,7 @@ class BudgetController extends Controller
     * ],
     *
     * @param DateRequest $request
-     *
+     * @deprecated
     * @return JsonResponse
     */
    public function overview(DateRequest $request): JsonResponse
@ -113,7 +113,7 @@ class BudgetController extends Controller
     * @param Collection $limits
     * @param Carbon     $start
     * @param Carbon     $end
-     *
+     * @deprecated
     * @return array
     */
    protected function getExpenses(Budget $budget, Carbon $start, Carbon $end): array
@ -135,7 +135,7 @@ class BudgetController extends Controller
     * @param Budget $budget
     * @param Carbon $start
     * @param Carbon $end
-     *
+     * @deprecated
     * @return array
     */
    private function getExpenseInRange(Budget $budget, Carbon $start, Carbon $end): array
@ -171,7 +171,7 @@ class BudgetController extends Controller

    /**
     * @param BudgetLimit $limit
-     *
+     * @deprecated
     * @return array
     */
    private function getExpensesForLimit(BudgetLimit $limit): array
@ -209,7 +209,7 @@ class BudgetController extends Controller

    /**
     * @param array $expenses
-     *
+     * @deprecated
     * @return array
     */
    private function filterNulls(array $expenses): array
@ -228,7 +228,7 @@ class BudgetController extends Controller
    /**
     * @param array $budgetNames
     * @param array $currencyNames
-     *
+     * @deprecated
     * @return array
     */
    private function createSets(array $budgetNames, array $currencyNames): array
@ -279,7 +279,7 @@ class BudgetController extends Controller
    /**
     * @param array $basic
     * @param array $sets
-     *
+     * @deprecated
     * @return array
     */
    private function fillSets(array $basic, array $sets): array
--- a/app/Api/V1/Controllers/Chart/CategoryController.php
+++ b/app/Api/V1/Controllers/Chart/CategoryController.php
@ -45,7 +45,7 @@ class CategoryController extends Controller

    /**
     * AccountController constructor.
-     *
+     * @deprecated
     * @codeCoverageIgnore
     */
    public function __construct()
@ -71,7 +71,7 @@ class CategoryController extends Controller

    /**
     * @param DateRequest $request
-     *
+     * @deprecated
     * @return JsonResponse
     */
    public function overview(DateRequest $request): JsonResponse
@ -100,7 +100,7 @@ class CategoryController extends Controller
    /**
     * @param array $tempData
     * @param array $set
-     *
+     * @deprecated
     * @return array
     */
    private function processArray(array $tempData, array $set): array
@ -135,7 +135,7 @@ class CategoryController extends Controller

    /**
     * @param array $tempData
-     *
+     * @deprecated
     * @return array
     */
    private function sortArray(array $tempData): array
--- a/app/Api/V1/Controllers/Summary/BasicController.php
+++ b/app/Api/V1/Controllers/Summary/BasicController.php
@ -1,8 +1,8 @@
 <?php

-/**
+/*
 * SummaryController.php
- * Copyright (c) 2019 james@firefly-iii.org
+ * Copyright (c) 2021 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
@ -22,10 +22,11 @@

 declare(strict_types=1);

-namespace FireflyIII\Api\V1\Controllers;
+namespace FireflyIII\Api\V1\Controllers\Summary;

 use Carbon\Carbon;
 use Exception;
+use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\DateRequest;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Helpers\Report\NetWorthInterface;
@ -43,9 +44,9 @@ use FireflyIII\User;
 use Illuminate\Http\JsonResponse;

 /**
- * Class SummaryController
+ * Class BasicController
 */
-class SummaryController extends Controller
+class BasicController extends Controller
 {
    private AvailableBudgetRepositoryInterface $abRepository;
    private AccountRepositoryInterface $accountRepository;
@ -55,7 +56,7 @@ class SummaryController extends Controller
    private OperationsRepositoryInterface $opsRepository;

    /**
-     * SummaryController constructor.
+     * BasicController constructor.
     *
     * @codeCoverageIgnore
     */
--- a/routes/api.php
+++ b/routes/api.php
@ -25,6 +25,68 @@ declare(strict_types=1);

 use FireflyIII\Http\Middleware\IsAdmin;

+/**
+ * Autocomplete controllers
+ */
+Route::group(
+    ['namespace' => 'FireflyIII\Api\V1\Controllers\Autocomplete', 'prefix' => 'autocomplete',
+     'as'        => 'api.v1.autocomplete.',],
+    static function () {
+        // Auto complete routes
+        Route::get('accounts', ['uses' => 'AccountController@accounts', 'as' => 'accounts']);
+        Route::get('bills', ['uses' => 'BillController@bills', 'as' => 'bills']);
+        Route::get('budgets', ['uses' => 'BudgetController@budgets', 'as' => 'budgets']);
+        Route::get('categories', ['uses' => 'CategoryController@categories', 'as' => 'categories']);
+        Route::get('currencies', ['uses' => 'CurrencyController@currencies', 'as' => 'currencies']);
+        Route::get('currencies-with-code', ['uses' => 'CurrencyController@currenciesWithCode', 'as' => 'currencies-with-code']);
+        Route::get('object-groups', ['uses' => 'ObjectGroupController@objectGroups', 'as' => 'object-groups']);
+        Route::get('piggy-banks', ['uses' => 'PiggyBankController@piggyBanks', 'as' => 'piggy-banks']);
+        Route::get('piggy-banks-with-balance', ['uses' => 'PiggyBankController@piggyBanksWithBalance', 'as' => 'piggy-banks-with-balance']);
+        // TODO create me:
+        Route::get('rules', ['uses' => 'RuleController@rules', 'as' => 'rules']);
+        // TODO create me:
+        Route::get('rule-groups', ['uses' => 'RuleGroupController@rules', 'as' => 'rule-groups']);
+        Route::get('tags', ['uses' => 'TagController@tags', 'as' => 'tags']);
+        Route::get('transactions', ['uses' => 'TransactionController@transactions', 'as' => 'transactions']);
+        Route::get('transactions-with-id', ['uses' => 'TransactionController@transactionsWithID', 'as' => 'transactions-with-id']);
+        Route::get('transaction-types', ['uses' => 'TransactionTypeController@transactionTypes', 'as' => 'transaction-types']);
+    }
+);
+
+/**
+ * CHART ROUTES.
+ */
+// Accounts
+Route::group(
+    ['namespace' => 'FireflyIII\Api\V1\Controllers\Chart', 'prefix' => 'chart/account',
+     'as'        => 'api.v1.chart.account.',],
+    static function () {
+        Route::get('overview', ['uses' => 'AccountController@overview', 'as' => 'overview']);
+    }
+);
+
+/**
+ * SUMMARY CONTROLLER
+ */
+// BASIC
+Route::group(
+    ['namespace' => 'FireflyIII\Api\V1\Controllers\Summary', 'prefix' => 'summary',
+     'as'        => 'api.v1.summary.',],
+    static function () {
+        Route::get('basic', ['uses' => 'BasicController@basic', 'as' => 'basic']);
+    }
+);
+
+
+
+
+
+
+
+
+
+
+
 /**
 * System and configuration controllers
 */
@ -93,27 +155,7 @@ Route::group(
    }
 );

-// TODO VERIFY API DOCS
-Route::group(
-    ['namespace' => 'FireflyIII\Api\V1\Controllers\Autocomplete', 'prefix' => 'autocomplete',
-     'as'        => 'api.v1.autocomplete.',],
-    static function () {
-        // Auto complete routes
-        Route::get('accounts', ['uses' => 'AccountController@accounts', 'as' => 'accounts']);
-        Route::get('bills', ['uses' => 'BillController@bills', 'as' => 'bills']);
-        Route::get('budgets', ['uses' => 'BudgetController@budgets', 'as' => 'budgets']);
-        Route::get('categories', ['uses' => 'CategoryController@categories', 'as' => 'categories']);
-        Route::get('currencies', ['uses' => 'CurrencyController@currencies', 'as' => 'currencies']);
-        Route::get('currencies-with-code', ['uses' => 'CurrencyController@currenciesWithCode', 'as' => 'currencies-with-code']);
-        Route::get('object-groups', ['uses' => 'ObjectGroupController@objectGroups', 'as' => 'object-groups']);
-        Route::get('piggy-banks', ['uses' => 'PiggyBankController@piggyBanks', 'as' => 'piggy-banks']);
-        Route::get('piggy-banks-with-balance', ['uses' => 'PiggyBankController@piggyBanksWithBalance', 'as' => 'piggy-banks-with-balance']);
-        Route::get('tags', ['uses' => 'TagController@tags', 'as' => 'tags']);
-        Route::get('transactions', ['uses' => 'TransactionController@transactions', 'as' => 'transactions']);
-        Route::get('transactions-with-id', ['uses' => 'TransactionController@transactionsWithID', 'as' => 'transactions-with-id']);
-        Route::get('transaction-types', ['uses' => 'TransactionTypeController@transactionTypes', 'as' => 'transaction-types']);
-    }
-);
+

 // TODO VERIFY API DOCS
 Route::group(
@ -237,57 +279,7 @@ Route::group(
    }
 );

-/**
- * CHART ROUTES.
- */

-// Accounts
-// TODO VERIFY API DOCS
-Route::group(
-    ['namespace' => 'FireflyIII\Api\V1\Controllers\Chart', 'prefix' => 'chart/account',
-     'as'        => 'api.v1.chart.account.',],
-    static function () {
-        Route::get('overview', ['uses' => 'AccountController@overview', 'as' => 'overview']);
-        Route::get('expense', ['uses' => 'AccountController@expenseOverview', 'as' => 'expense']);
-        Route::get('revenue', ['uses' => 'AccountController@revenueOverview', 'as' => 'revenue']);
-    }
-);
-
-// Available budgets
-// TODO VERIFY API DOCS
-Route::group(
-    ['namespace' => 'FireflyIII\Api\V1\Controllers\Chart', 'prefix' => 'chart/ab',
-     'as'        => 'api.v1.chart.ab.',],
-    static function () {
-
-        // Overview API routes:
-        Route::get('overview/{availableBudget}', ['uses' => 'AvailableBudgetController@overview', 'as' => 'overview']);
-    }
-);
-
-// Budgets
-// TODO VERIFY API DOCS
-Route::group(
-    ['namespace' => 'FireflyIII\Api\V1\Controllers\Chart', 'prefix' => 'chart/budget',
-     'as'        => 'api.v1.chart.budget.',],
-    static function () {
-
-        // (frontpage) budget overview
-        Route::get('overview', ['uses' => 'BudgetController@overview', 'as' => 'overview']);
-    }
-);
-
-// Categories
-// TODO VERIFY API DOCS
-Route::group(
-    ['namespace' => 'FireflyIII\Api\V1\Controllers\Chart', 'prefix' => 'chart/category',
-     'as'        => 'api.v1.chart.category.',],
-    static function () {
-
-        // Overview API routes:
-        Route::get('overview', ['uses' => 'CategoryController@overview', 'as' => 'overview']);
-    }
-);

 // TODO VERIFY API DOCS
 Route::group(
@ -450,16 +442,7 @@ Route::group(
    }
 );

-// TODO VERIFY API DOCS
-Route::group(
-    ['namespace' => 'FireflyIII\Api\V1\Controllers', 'prefix' => 'summary',
-     'as'        => 'api.v1.summary.',],
-    static function () {

-        // Overview API routes:
-        Route::get('basic', ['uses' => 'SummaryController@basic', 'as' => 'basic']);
-    }
-);

 // destroy data route.
 // TODO VERIFY API DOCS