Append API links

This commit is contained in:
James Cole 2021-09-19 10:20:28 +02:00
parent 18fad5f115
commit 1efbbe4b84
No known key found for this signature in database
GPG Key ID: BDE6667570EADBD5
54 changed files with 254 additions and 4 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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