Add links to endpoints.

This commit is contained in:
James Cole 2021-09-19 08:27:52 +02:00
parent 4003cea759
commit a2dedde094
No known key found for this signature in database
GPG Key ID: BDE6667570EADBD5
18 changed files with 80 additions and 2 deletions

View File

@ -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. * Display the specified resource.
* *
* @param AvailableBudget $availableBudget * @param AvailableBudget $availableBudget

View File

@ -25,11 +25,13 @@ namespace FireflyIII\Api\V1\Controllers\Models\AvailableBudget;
use FireflyIII\Api\V1\Controllers\Controller; use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Api\V1\Requests\Models\AvailableBudget\Request; use FireflyIII\Api\V1\Requests\Models\AvailableBudget\Request;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Factory\TransactionCurrencyFactory; use FireflyIII\Factory\TransactionCurrencyFactory;
use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface; use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
use FireflyIII\Transformers\AvailableBudgetTransformer; use FireflyIII\Transformers\AvailableBudgetTransformer;
use FireflyIII\User; use FireflyIII\User;
use Illuminate\Http\JsonResponse; use Illuminate\Http\JsonResponse;
use JsonException;
use League\Fractal\Resource\Item; 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. * Store a newly created resource in storage.
* *
* @param Request $request * @param Request $request
* *
* @return JsonResponse * @return JsonResponse
* @throws FireflyException
* @throws JsonException
*/ */
public function store(Request $request): JsonResponse public function store(Request $request): JsonResponse
{ {

View File

@ -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. * Update the specified resource in storage.
* *
* @param Request $request * @param Request $request

View File

@ -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. * Remove the specified resource from storage.
* *
* @param Bill $bill * @param Bill $bill

View File

@ -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. * Display a listing of the resource.
* *
* @param Bill $bill * @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. * List all of them.
* *
* @param Bill $bill * @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. * Show all transactions.
* *
* @param Request $request * @param Request $request

View File

@ -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. * Display a listing of the resource.
* *
* @return JsonResponse * @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. * Show the specified bill.
* *
* @param Bill $bill * @param Bill $bill

View File

@ -60,6 +60,9 @@ class StoreController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/bills/storeBill
*
* Store a bill. * Store a bill.
* *
* @param StoreRequest $request * @param StoreRequest $request

View File

@ -57,6 +57,9 @@ class UpdateController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/bills/updateBill
*
* Update a bill. * Update a bill.
* *
* @param UpdateRequest $request * @param UpdateRequest $request

View File

@ -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. * Remove the specified resource from storage.
* *
* @param Budget $budget * @param Budget $budget

View File

@ -71,6 +71,9 @@ class ListController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/budgets/listAttachmentByBudget
*
* @param Budget $budget * @param Budget $budget
* *
* @return JsonResponse * @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. * Display a listing of the resource.
* *
* @param Budget $budget * @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. * Show all transactions.
* *
* @param Request $request * @param Request $request

View File

@ -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. * Display a listing of the resource.
* *
* @return JsonResponse * @return JsonResponse

View File

@ -57,6 +57,9 @@ class StoreController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/budgets/storeBudget
*
* Store a budget. * Store a budget.
* *
* @param StoreRequest $request * @param StoreRequest $request

View File

@ -57,6 +57,9 @@ class UpdateController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/budgets/updateBudget
*
* Update a budget. * Update a budget.
* *
* @param UpdateRequest $request * @param UpdateRequest $request

View File

@ -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. * Remove the specified resource from storage.
* *
* @param Budget $budget * @param Budget $budget

View File

@ -67,6 +67,8 @@ class ListController extends Controller
} }
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/budgets/listTransactionByBudgetLimit
* Show all transactions. * Show all transactions.
* *
* @param Request $request * @param Request $request

View File

@ -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 Request $request
* @param Budget $budget * @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 * @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 Request $request
* @param Budget $budget * @param Budget $budget
* @param BudgetLimit $budgetLimit * @param BudgetLimit $budgetLimit

View File

@ -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. * Store a newly created resource in storage.
* *
* @param StoreRequest $request * @param StoreRequest $request

View File

@ -42,6 +42,9 @@ class UpdateController extends Controller
private BudgetLimitRepositoryInterface $blRepository; private BudgetLimitRepositoryInterface $blRepository;
/** /**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/budgets/updateBudgetLimit
*
* BudgetLimitController constructor. * BudgetLimitController constructor.
* *
* @codeCoverageIgnore * @codeCoverageIgnore