diff --git a/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php b/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php index 212178597d..24d7a1608b 100644 --- a/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php +++ b/app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php @@ -102,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 diff --git a/app/Api/V1/Controllers/Models/AvailableBudget/StoreController.php b/app/Api/V1/Controllers/Models/AvailableBudget/StoreController.php index 860688e55a..38deff3b1f 100644 --- a/app/Api/V1/Controllers/Models/AvailableBudget/StoreController.php +++ b/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 { diff --git a/app/Api/V1/Controllers/Models/AvailableBudget/UpdateController.php b/app/Api/V1/Controllers/Models/AvailableBudget/UpdateController.php index 864c8d7840..bb0969260c 100644 --- a/app/Api/V1/Controllers/Models/AvailableBudget/UpdateController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Models/Bill/DestroyController.php b/app/Api/V1/Controllers/Models/Bill/DestroyController.php index 271c593d1f..b9ca5e2531 100644 --- a/app/Api/V1/Controllers/Models/Bill/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Bill/DestroyController.php @@ -54,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 diff --git a/app/Api/V1/Controllers/Models/Bill/ListController.php b/app/Api/V1/Controllers/Models/Bill/ListController.php index e9f5996fae..b73e94942b 100644 --- a/app/Api/V1/Controllers/Models/Bill/ListController.php +++ b/app/Api/V1/Controllers/Models/Bill/ListController.php @@ -67,6 +67,9 @@ 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 @@ -99,6 +102,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/bills/listRuleByBill + * * List all of them. * * @param Bill $bill @@ -134,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 diff --git a/app/Api/V1/Controllers/Models/Bill/ShowController.php b/app/Api/V1/Controllers/Models/Bill/ShowController.php index 58b0de32b4..5246af526a 100644 --- a/app/Api/V1/Controllers/Models/Bill/ShowController.php +++ b/app/Api/V1/Controllers/Models/Bill/ShowController.php @@ -60,6 +60,9 @@ 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 @@ -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 diff --git a/app/Api/V1/Controllers/Models/Bill/StoreController.php b/app/Api/V1/Controllers/Models/Bill/StoreController.php index d3bfd2cc04..f28e8fbdfe 100644 --- a/app/Api/V1/Controllers/Models/Bill/StoreController.php +++ b/app/Api/V1/Controllers/Models/Bill/StoreController.php @@ -60,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 diff --git a/app/Api/V1/Controllers/Models/Bill/UpdateController.php b/app/Api/V1/Controllers/Models/Bill/UpdateController.php index 23e1e92cdf..d5fdf38b03 100644 --- a/app/Api/V1/Controllers/Models/Bill/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Bill/UpdateController.php @@ -57,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 diff --git a/app/Api/V1/Controllers/Models/Budget/DestroyController.php b/app/Api/V1/Controllers/Models/Budget/DestroyController.php index 81b8012303..2d8f11cda1 100644 --- a/app/Api/V1/Controllers/Models/Budget/DestroyController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Models/Budget/ListController.php b/app/Api/V1/Controllers/Models/Budget/ListController.php index 3130c016f6..8dc6ef727b 100644 --- a/app/Api/V1/Controllers/Models/Budget/ListController.php +++ b/app/Api/V1/Controllers/Models/Budget/ListController.php @@ -71,6 +71,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/budgets/listAttachmentByBudget + * * @param Budget $budget * * @return JsonResponse @@ -101,6 +104,9 @@ 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 @@ -130,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 diff --git a/app/Api/V1/Controllers/Models/Budget/ShowController.php b/app/Api/V1/Controllers/Models/Budget/ShowController.php index bfe12fcc3d..f2831e1918 100644 --- a/app/Api/V1/Controllers/Models/Budget/ShowController.php +++ b/app/Api/V1/Controllers/Models/Budget/ShowController.php @@ -64,6 +64,9 @@ 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 diff --git a/app/Api/V1/Controllers/Models/Budget/StoreController.php b/app/Api/V1/Controllers/Models/Budget/StoreController.php index 6ea43ad78c..af1d80251b 100644 --- a/app/Api/V1/Controllers/Models/Budget/StoreController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Models/Budget/UpdateController.php b/app/Api/V1/Controllers/Models/Budget/UpdateController.php index 94094a4f94..ce40281086 100644 --- a/app/Api/V1/Controllers/Models/Budget/UpdateController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php b/app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php index 7da2351c0b..70535133a9 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/DestroyController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/ListController.php b/app/Api/V1/Controllers/Models/BudgetLimit/ListController.php index 4ac3877315..79a03c0cce 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/ListController.php +++ b/app/Api/V1/Controllers/Models/BudgetLimit/ListController.php @@ -67,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 diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php b/app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php index 8ca384fd8f..108a8612d8 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/ShowController.php +++ b/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 diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php b/app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php index 697c950aeb..d5630273fd 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php +++ b/app/Api/V1/Controllers/Models/BudgetLimit/StoreController.php @@ -60,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 diff --git a/app/Api/V1/Controllers/Models/BudgetLimit/UpdateController.php b/app/Api/V1/Controllers/Models/BudgetLimit/UpdateController.php index 055e91bd92..54150f26da 100644 --- a/app/Api/V1/Controllers/Models/BudgetLimit/UpdateController.php +++ b/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