diff --git a/app/Api/V1/Controllers/Models/Category/DestroyController.php b/app/Api/V1/Controllers/Models/Category/DestroyController.php index 2890584cbb..4d7b1e1681 100644 --- a/app/Api/V1/Controllers/Models/Category/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Category/DestroyController.php @@ -54,6 +54,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/categories/deleteCategory + * * Remove the specified resource from storage. * * @param Category $category diff --git a/app/Api/V1/Controllers/Models/Category/ListController.php b/app/Api/V1/Controllers/Models/Category/ListController.php index d4be312707..ceb2fd5d1e 100644 --- a/app/Api/V1/Controllers/Models/Category/ListController.php +++ b/app/Api/V1/Controllers/Models/Category/ListController.php @@ -66,6 +66,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/categories/listAttachmentByCategory + * * @param Category $category * * @return JsonResponse @@ -96,6 +99,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/categories/listTransactionByCategory + * * Show all transactions. * * @param Request $request diff --git a/app/Api/V1/Controllers/Models/Category/ShowController.php b/app/Api/V1/Controllers/Models/Category/ShowController.php index 3b4d6418b2..d463a6ce52 100644 --- a/app/Api/V1/Controllers/Models/Category/ShowController.php +++ b/app/Api/V1/Controllers/Models/Category/ShowController.php @@ -60,6 +60,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/categories/listCategory + * * Display a listing of the resource. * * @return JsonResponse @@ -92,6 +95,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/categories/getCategory + * * Show the category. * * @param Category $category diff --git a/app/Api/V1/Controllers/Models/Category/StoreController.php b/app/Api/V1/Controllers/Models/Category/StoreController.php index 161987545d..3b93112db7 100644 --- a/app/Api/V1/Controllers/Models/Category/StoreController.php +++ b/app/Api/V1/Controllers/Models/Category/StoreController.php @@ -57,6 +57,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/categories/storeCategory + * * Store new category. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/Category/UpdateController.php b/app/Api/V1/Controllers/Models/Category/UpdateController.php index 1c1975a8d4..66bfce6859 100644 --- a/app/Api/V1/Controllers/Models/Category/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Category/UpdateController.php @@ -57,6 +57,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/categories/updateCategory + * * Update the category. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php b/app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php index 0fc6447f84..cc8211b4dd 100644 --- a/app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php +++ b/app/Api/V1/Controllers/Models/ObjectGroup/DestroyController.php @@ -57,6 +57,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/object_groups/deleteObjectGroup + * * Remove the specified resource from storage. * * @param ObjectGroup $objectGroup diff --git a/app/Api/V1/Controllers/Models/ObjectGroup/ListController.php b/app/Api/V1/Controllers/Models/ObjectGroup/ListController.php index 7b3db64c16..8ac8308e6f 100644 --- a/app/Api/V1/Controllers/Models/ObjectGroup/ListController.php +++ b/app/Api/V1/Controllers/Models/ObjectGroup/ListController.php @@ -63,7 +63,10 @@ class ListController extends Controller } /** - * List all bills + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/object_groups/listBillByObjectGroup + * + * List all bills in this object group * * @param ObjectGroup $objectGroup * @@ -96,6 +99,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/object_groups/listPiggyBankByObjectGroup + * * List all piggies under the object group. * * @param ObjectGroup $objectGroup diff --git a/app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php b/app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php index 15e97c5798..c11d756761 100644 --- a/app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php +++ b/app/Api/V1/Controllers/Models/ObjectGroup/ShowController.php @@ -64,6 +64,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/object_groups/listObjectGroups + * * Display a listing of the resource. * * @param Request $request @@ -99,6 +102,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/object_groups/getObjectGroup + * * Show single instance. * * @param ObjectGroup $objectGroup diff --git a/app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php b/app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php index 4f60d9b37e..45a8858f39 100644 --- a/app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php +++ b/app/Api/V1/Controllers/Models/ObjectGroup/UpdateController.php @@ -60,6 +60,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/object_groups/updateObjectGroup + * * @param UpdateRequest $request * @param ObjectGroup $objectGroup * diff --git a/app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php b/app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php index 0f85923d97..27b8ce10c0 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/DestroyController.php @@ -54,6 +54,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/piggy_banks/deletePiggyBank + * * Delete the resource. * * @param PiggyBank $piggyBank diff --git a/app/Api/V1/Controllers/Models/PiggyBank/ListController.php b/app/Api/V1/Controllers/Models/PiggyBank/ListController.php index a4d771e8de..264e5dc528 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/ListController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/ListController.php @@ -60,6 +60,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/piggy_banks/listAttachmentByPiggyBank + * * @param PiggyBank $piggyBank * * @return JsonResponse @@ -90,6 +93,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/piggy_banks/listEventByPiggyBank + * * List single resource. * * @param PiggyBank $piggyBank diff --git a/app/Api/V1/Controllers/Models/PiggyBank/ShowController.php b/app/Api/V1/Controllers/Models/PiggyBank/ShowController.php index 24b9e5b1ab..37e86c867d 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/ShowController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/ShowController.php @@ -60,6 +60,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/piggy_banks/listPiggyBank + * * List all of them. * * @return JsonResponse @@ -93,6 +96,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/piggy_banks/getPiggyBank + * * List single resource. * * @param PiggyBank $piggyBank diff --git a/app/Api/V1/Controllers/Models/PiggyBank/StoreController.php b/app/Api/V1/Controllers/Models/PiggyBank/StoreController.php index 0f4e7a01f1..a1bdd1dfc1 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/StoreController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/StoreController.php @@ -57,6 +57,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/piggy_banks/storePiggyBank + * * Store new object. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php b/app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php index a48678d439..e6634cf5e2 100644 --- a/app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php +++ b/app/Api/V1/Controllers/Models/PiggyBank/UpdateController.php @@ -57,6 +57,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/piggy_banks/updatePiggyBank + * * Update piggy bank. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/Recurrence/DestroyController.php b/app/Api/V1/Controllers/Models/Recurrence/DestroyController.php index 59ebdf7b0c..0eb3bb0bf3 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/DestroyController.php @@ -54,6 +54,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/recurrences/deleteRecurrence + * * Delete the resource. * * @param Recurrence $recurrence diff --git a/app/Api/V1/Controllers/Models/Recurrence/ListController.php b/app/Api/V1/Controllers/Models/Recurrence/ListController.php index 6e96436048..17cf615b66 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/ListController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/ListController.php @@ -64,6 +64,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/recurrences/listTransactionByRecurrence + * * Show transactions for this recurrence. * * @param Request $request diff --git a/app/Api/V1/Controllers/Models/Recurrence/ShowController.php b/app/Api/V1/Controllers/Models/Recurrence/ShowController.php index 71a66bca59..bad3f2fbc5 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/ShowController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/ShowController.php @@ -60,6 +60,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/recurrences/listRecurrence + * * List all of them. * * @return JsonResponse @@ -94,6 +97,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/recurrences/getRecurrence + * * List single resource. * * @param Recurrence $recurrence diff --git a/app/Api/V1/Controllers/Models/Recurrence/StoreController.php b/app/Api/V1/Controllers/Models/Recurrence/StoreController.php index fdf2ce0761..03c60fd43a 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/StoreController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/StoreController.php @@ -57,6 +57,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/recurrences/storeRecurrence + * * Store new object. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/Recurrence/UpdateController.php b/app/Api/V1/Controllers/Models/Recurrence/UpdateController.php index 2df4087347..18696ee68e 100644 --- a/app/Api/V1/Controllers/Models/Recurrence/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Recurrence/UpdateController.php @@ -57,6 +57,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/recurrences/updateRecurrence + * * Update single recurrence. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/Rule/DestroyController.php b/app/Api/V1/Controllers/Models/Rule/DestroyController.php index 97b3313b3d..a2503c116e 100644 --- a/app/Api/V1/Controllers/Models/Rule/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Rule/DestroyController.php @@ -58,6 +58,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rules/deleteRule + * * Delete the resource. * * @param Rule $rule diff --git a/app/Api/V1/Controllers/Models/Rule/ShowController.php b/app/Api/V1/Controllers/Models/Rule/ShowController.php index 38e6e60cbc..6ab5b01e2c 100644 --- a/app/Api/V1/Controllers/Models/Rule/ShowController.php +++ b/app/Api/V1/Controllers/Models/Rule/ShowController.php @@ -64,6 +64,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rules/listRule + * * List all of them. * * @return JsonResponse @@ -98,6 +101,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rules/getRule + * * List single resource. * * @param Rule $rule diff --git a/app/Api/V1/Controllers/Models/Rule/StoreController.php b/app/Api/V1/Controllers/Models/Rule/StoreController.php index a51870c668..7d861c71f4 100644 --- a/app/Api/V1/Controllers/Models/Rule/StoreController.php +++ b/app/Api/V1/Controllers/Models/Rule/StoreController.php @@ -60,6 +60,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rules/storeRule + * * Store new object. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/Rule/TriggerController.php b/app/Api/V1/Controllers/Models/Rule/TriggerController.php index dd7b818fa1..7f5f2eae8d 100644 --- a/app/Api/V1/Controllers/Models/Rule/TriggerController.php +++ b/app/Api/V1/Controllers/Models/Rule/TriggerController.php @@ -66,6 +66,9 @@ class TriggerController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rules/testRule + * * @param TestRequest $request * @param Rule $rule * @@ -113,6 +116,9 @@ class TriggerController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rules/fireRule + * * Execute the given rule group on a set of existing transactions. * * @param TriggerRequest $request diff --git a/app/Api/V1/Controllers/Models/Rule/UpdateController.php b/app/Api/V1/Controllers/Models/Rule/UpdateController.php index 28a25fe7d4..28859b99de 100644 --- a/app/Api/V1/Controllers/Models/Rule/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Rule/UpdateController.php @@ -61,6 +61,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rules/updateRule + * * Update a rule. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php b/app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php index 037ba21be3..f520f18544 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/DestroyController.php @@ -58,6 +58,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rule_groups/deleteRuleGroup + * * Delete the resource. * * @param RuleGroup $ruleGroup diff --git a/app/Api/V1/Controllers/Models/RuleGroup/ListController.php b/app/Api/V1/Controllers/Models/RuleGroup/ListController.php index 73b8780155..30e7c3a68b 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/ListController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/ListController.php @@ -63,6 +63,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rule_groups/listRuleByGroup + * * @param RuleGroup $group * * @return JsonResponse diff --git a/app/Api/V1/Controllers/Models/RuleGroup/ShowController.php b/app/Api/V1/Controllers/Models/RuleGroup/ShowController.php index 3f053495a9..7e77e6fd41 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/ShowController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/ShowController.php @@ -64,6 +64,8 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rule_groups/listRuleGroup * List all of them. * * @return JsonResponse @@ -96,6 +98,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rule_groups/getRuleGroup + * * List single resource. * * @param RuleGroup $ruleGroup diff --git a/app/Api/V1/Controllers/Models/RuleGroup/StoreController.php b/app/Api/V1/Controllers/Models/RuleGroup/StoreController.php index cb1319368e..0487988536 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/StoreController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/StoreController.php @@ -66,6 +66,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rule_groups/storeRuleGroup + * * Store new object. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/RuleGroup/TriggerController.php b/app/Api/V1/Controllers/Models/RuleGroup/TriggerController.php index 31fccaca88..98c4d37793 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/TriggerController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/TriggerController.php @@ -67,6 +67,9 @@ class TriggerController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rule_groups/testRuleGroup + * * @param TestRequest $request * @param RuleGroup $group * @@ -120,6 +123,9 @@ class TriggerController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rule_groups/fireRuleGroup + * * Execute the given rule group on a set of existing transactions. * * @param TriggerRequest $request diff --git a/app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php b/app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php index 840c1f43e4..2cb39726ac 100644 --- a/app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php +++ b/app/Api/V1/Controllers/Models/RuleGroup/UpdateController.php @@ -62,6 +62,9 @@ class UpdateController extends Controller } /** + * This is endpoint is documented at: + * https://api-docs.firefly-iii.org/#/rule_groups/updateRuleGroup + * * Update a rule group. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/Tag/DestroyController.php b/app/Api/V1/Controllers/Models/Tag/DestroyController.php index dd7a5f8068..c7c339d0aa 100644 --- a/app/Api/V1/Controllers/Models/Tag/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Tag/DestroyController.php @@ -58,6 +58,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/tags/deleteTag + * * Delete the resource. * * @param Tag $tag diff --git a/app/Api/V1/Controllers/Models/Tag/ListController.php b/app/Api/V1/Controllers/Models/Tag/ListController.php index 3bde6c175b..51ef7f7307 100644 --- a/app/Api/V1/Controllers/Models/Tag/ListController.php +++ b/app/Api/V1/Controllers/Models/Tag/ListController.php @@ -69,6 +69,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/tags/listAttachmentByTag + * * @param Tag $tag * * @return JsonResponse @@ -99,6 +102,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/tags/listTransactionByTag + * * Show all transactions. * * @param Request $request diff --git a/app/Api/V1/Controllers/Models/Tag/ShowController.php b/app/Api/V1/Controllers/Models/Tag/ShowController.php index 162936208f..dc4e58162d 100644 --- a/app/Api/V1/Controllers/Models/Tag/ShowController.php +++ b/app/Api/V1/Controllers/Models/Tag/ShowController.php @@ -64,6 +64,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/tags/listTag + * * List all of them. * * @return JsonResponse @@ -96,6 +99,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/tags/getTag + * * List single resource. * * @param Tag $tag diff --git a/app/Api/V1/Controllers/Models/Tag/StoreController.php b/app/Api/V1/Controllers/Models/Tag/StoreController.php index fd8346887f..c31e903c6a 100644 --- a/app/Api/V1/Controllers/Models/Tag/StoreController.php +++ b/app/Api/V1/Controllers/Models/Tag/StoreController.php @@ -60,6 +60,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/tags/storeTag + * * Store new object. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/Tag/UpdateController.php b/app/Api/V1/Controllers/Models/Tag/UpdateController.php index 5bc869d5b3..377c362f3f 100644 --- a/app/Api/V1/Controllers/Models/Tag/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Tag/UpdateController.php @@ -61,6 +61,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/tags/updateTag + * * Update a rule. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/Transaction/DestroyController.php b/app/Api/V1/Controllers/Models/Transaction/DestroyController.php index a3ac9dc901..7d46ffad4a 100644 --- a/app/Api/V1/Controllers/Models/Transaction/DestroyController.php +++ b/app/Api/V1/Controllers/Models/Transaction/DestroyController.php @@ -60,6 +60,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/deleteTransaction + * * Remove the specified resource from storage. * * @param TransactionGroup $transactionGroup @@ -77,6 +80,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/deleteTransactionJournal + * * Remove the specified resource from storage. * * @param TransactionJournal $transactionJournal diff --git a/app/Api/V1/Controllers/Models/Transaction/ListController.php b/app/Api/V1/Controllers/Models/Transaction/ListController.php index 2903499ebe..19e9569df1 100644 --- a/app/Api/V1/Controllers/Models/Transaction/ListController.php +++ b/app/Api/V1/Controllers/Models/Transaction/ListController.php @@ -67,6 +67,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/listAttachmentByTransaction + * * @param TransactionGroup $transactionGroup * * @return JsonResponse @@ -100,6 +103,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/listEventByTransaction + * * @param TransactionGroup $transactionGroup * * @return JsonResponse @@ -136,6 +142,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/listLinksByJournal + * * @param TransactionJournal $transactionJournal * * @return JsonResponse diff --git a/app/Api/V1/Controllers/Models/Transaction/ShowController.php b/app/Api/V1/Controllers/Models/Transaction/ShowController.php index d14e6245f7..20af38f182 100644 --- a/app/Api/V1/Controllers/Models/Transaction/ShowController.php +++ b/app/Api/V1/Controllers/Models/Transaction/ShowController.php @@ -46,6 +46,9 @@ class ShowController extends Controller use TransactionFilter; /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/listTransaction + * * Show all transactions. * * @param Request $request @@ -96,6 +99,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/getTransactionByJournal + * * Show a single transaction, by transaction journal. * * @param TransactionJournal $transactionJournal @@ -109,6 +115,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/getTransaction + * * Show a single transaction. * * @param TransactionGroup $transactionGroup diff --git a/app/Api/V1/Controllers/Models/Transaction/StoreController.php b/app/Api/V1/Controllers/Models/Transaction/StoreController.php index 486c2eb7e6..29d43b8d9e 100644 --- a/app/Api/V1/Controllers/Models/Transaction/StoreController.php +++ b/app/Api/V1/Controllers/Models/Transaction/StoreController.php @@ -71,6 +71,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/storeTransaction + * * Store a new transaction. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/Transaction/UpdateController.php b/app/Api/V1/Controllers/Models/Transaction/UpdateController.php index 7363895779..500ad0d508 100644 --- a/app/Api/V1/Controllers/Models/Transaction/UpdateController.php +++ b/app/Api/V1/Controllers/Models/Transaction/UpdateController.php @@ -65,6 +65,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/transactions/updateTransaction + * * Update a transaction. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php index e22ee27ecc..f09bbc82d2 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/DestroyController.php @@ -60,6 +60,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/deleteCurrency + * * Remove the specified resource from storage. * * @param TransactionCurrency $currency diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/ListController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/ListController.php index c782690af0..94a8f80457 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/ListController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/ListController.php @@ -88,6 +88,8 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/listAccountByCurrency * Display a list of accounts. * * @param Request $request @@ -140,6 +142,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/listAvailableBudgetByCurrency + * * Display a listing of the resource. * * @param TransactionCurrency $currency @@ -176,6 +181,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/listBillByCurrency + * * List all bills * * @param TransactionCurrency $currency @@ -217,6 +225,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/listBudgetLimitByCurrency + * * List all budget limits * * @param TransactionCurrency $currency @@ -249,6 +260,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/listRecurrenceByCurrency + * * List all recurring transactions. * * @param TransactionCurrency $currency @@ -300,6 +314,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/listRuleByCurrency + * * List all of them. * * @param TransactionCurrency $currency @@ -350,6 +367,9 @@ class ListController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/listTransactionByCurrency + * * Show all transactions. * * @param Request $request diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/ShowController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/ShowController.php index bdf8630082..919a8ed085 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/ShowController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/ShowController.php @@ -65,6 +65,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/listCurrency + * * Display a listing of the resource. * * @return JsonResponse @@ -95,6 +98,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/getCurrency + * * Show a currency. * * @param TransactionCurrency $currency @@ -118,6 +124,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/getDefaultCurrency + * * Show a currency. * * @return JsonResponse diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/StoreController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/StoreController.php index bbab73e2e1..8902cc47cb 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/StoreController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/StoreController.php @@ -65,6 +65,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/storeCurrency + * * Store new currency. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/TransactionCurrency/UpdateController.php b/app/Api/V1/Controllers/Models/TransactionCurrency/UpdateController.php index 5f50d1886b..211b5cf964 100644 --- a/app/Api/V1/Controllers/Models/TransactionCurrency/UpdateController.php +++ b/app/Api/V1/Controllers/Models/TransactionCurrency/UpdateController.php @@ -67,6 +67,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/disableCurrency + * * Disable a currency. * * @param TransactionCurrency $currency @@ -97,6 +100,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/enableCurrency + * * Enable a currency. * * @param TransactionCurrency $currency @@ -123,6 +129,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/defaultCurrency + * * Make the currency a default currency. * * @param TransactionCurrency $currency @@ -153,6 +162,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/currencies/updateCurrency + * * Update a currency. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php b/app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php index b70feb91b0..cc50a7feed 100644 --- a/app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php +++ b/app/Api/V1/Controllers/Models/TransactionLink/DestroyController.php @@ -58,6 +58,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/deleteTransactionLink + * * Delete the resource. * * @param TransactionJournalLink $link diff --git a/app/Api/V1/Controllers/Models/TransactionLink/ShowController.php b/app/Api/V1/Controllers/Models/TransactionLink/ShowController.php index c24ac20190..db0a6aaf31 100644 --- a/app/Api/V1/Controllers/Models/TransactionLink/ShowController.php +++ b/app/Api/V1/Controllers/Models/TransactionLink/ShowController.php @@ -64,7 +64,10 @@ class ShowController extends Controller } /** - * List all of the transaction links there are. + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/listTransactionLink + * + * List all transaction links there are. * * @param Request $request * @@ -104,6 +107,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/getTransactionLink + * * List single resource. * * @param TransactionJournalLink $journalLink diff --git a/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php b/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php index 83305edd53..08eaf6de80 100644 --- a/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php +++ b/app/Api/V1/Controllers/Models/TransactionLink/StoreController.php @@ -67,6 +67,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/storeTransactionLink + * * Store new object. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php b/app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php index 3e9459070b..e95de834a9 100644 --- a/app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php +++ b/app/Api/V1/Controllers/Models/TransactionLink/UpdateController.php @@ -64,6 +64,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/updateTransactionLink + * * Update object. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php index 67d093b513..165185c146 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/DestroyController.php @@ -65,6 +65,9 @@ class DestroyController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/deleteLinkType + * * Delete the resource. * * @param LinkType $linkType diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/ListController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/ListController.php index 0964dbd90d..dd843887dd 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/ListController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/ListController.php @@ -70,7 +70,8 @@ class ListController extends Controller } /** - * Delete the resource. + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/listTransactionByLinkType * * @param Request $request * @param LinkType $linkType diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php index 081eff43f6..5046570c87 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/ShowController.php @@ -70,7 +70,9 @@ class ShowController extends Controller } /** - * List all of them. + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/listLinkType + * * * @return JsonResponse * @throws FireflyException @@ -103,6 +105,9 @@ class ShowController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/getLinkType + * * List single resource. * * @param LinkType $linkType diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php index f7917138e9..6a16ca9c34 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/StoreController.php @@ -67,6 +67,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/storeLinkType + * * Store new object. * * @param StoreRequest $request diff --git a/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php b/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php index 5ed66ec7e9..4eb5ad9ee4 100644 --- a/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php +++ b/app/Api/V1/Controllers/Models/TransactionLinkType/UpdateController.php @@ -68,6 +68,9 @@ class UpdateController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/links/updateLinkType + * * Update object. * * @param UpdateRequest $request