mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-09-30 10:33:30 +00:00
Add endpoint links.
This commit is contained in:
@@ -59,6 +59,8 @@ class AccountController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/search/searchAccounts
|
||||||
* @param Request $request
|
* @param Request $request
|
||||||
*
|
*
|
||||||
* @return JsonResponse|Response
|
* @return JsonResponse|Response
|
||||||
|
@@ -39,6 +39,9 @@ use League\Fractal\Resource\Collection;
|
|||||||
class TransactionController extends Controller
|
class TransactionController extends Controller
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/search/searchTransactions
|
||||||
|
*
|
||||||
* @param Request $request
|
* @param Request $request
|
||||||
* @param SearchInterface $searcher
|
* @param SearchInterface $searcher
|
||||||
*
|
*
|
||||||
|
@@ -87,6 +87,9 @@ class BasicController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/summary/getBasicSummary
|
||||||
|
*
|
||||||
* @param DateRequest $request
|
* @param DateRequest $request
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
|
@@ -39,6 +39,9 @@ use League\Fractal\Resource\Item;
|
|||||||
class AboutController extends Controller
|
class AboutController extends Controller
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/about/getAbout
|
||||||
|
*
|
||||||
* Returns system information.
|
* Returns system information.
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
@@ -63,6 +66,9 @@ class AboutController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/about/getCurrentUser
|
||||||
|
*
|
||||||
* Returns information about the user.
|
* Returns information about the user.
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
|
@@ -54,6 +54,9 @@ class ConfigurationController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/configuration/getConfiguration
|
||||||
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
* @throws FireflyException
|
* @throws FireflyException
|
||||||
*/
|
*/
|
||||||
@@ -122,6 +125,9 @@ class ConfigurationController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/configuration/getSingleConfiguration
|
||||||
|
*
|
||||||
* @param string $configKey
|
* @param string $configKey
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
@@ -151,6 +157,9 @@ class ConfigurationController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/configuration/setConfiguration
|
||||||
|
*
|
||||||
* Update the configuration.
|
* Update the configuration.
|
||||||
*
|
*
|
||||||
* @param UpdateRequest $request
|
* @param UpdateRequest $request
|
||||||
|
@@ -37,6 +37,9 @@ class CronController extends Controller
|
|||||||
use CronRunner;
|
use CronRunner;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/about/getCron
|
||||||
|
*
|
||||||
* @param CronRequest $request
|
* @param CronRequest $request
|
||||||
* @param string $token
|
* @param string $token
|
||||||
*
|
*
|
||||||
|
@@ -62,6 +62,9 @@ class UserController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/users/deleteUser
|
||||||
|
*
|
||||||
* Remove the specified resource from storage.
|
* Remove the specified resource from storage.
|
||||||
*
|
*
|
||||||
* @param User $user
|
* @param User $user
|
||||||
@@ -87,6 +90,9 @@ class UserController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/users/listUser
|
||||||
|
*
|
||||||
* Display a listing of the resource.
|
* Display a listing of the resource.
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
@@ -120,6 +126,9 @@ class UserController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/users/getUser
|
||||||
|
*
|
||||||
* Show a single user.
|
* Show a single user.
|
||||||
*
|
*
|
||||||
* @param User $user
|
* @param User $user
|
||||||
@@ -142,6 +151,9 @@ class UserController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/users/storeUser
|
||||||
|
*
|
||||||
* Store a new user.
|
* Store a new user.
|
||||||
*
|
*
|
||||||
* @param UserStoreRequest $request
|
* @param UserStoreRequest $request
|
||||||
@@ -166,6 +178,9 @@ class UserController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/users/updateUser
|
||||||
|
*
|
||||||
* Update a user.
|
* Update a user.
|
||||||
*
|
*
|
||||||
* @param UserUpdateRequest $request
|
* @param UserUpdateRequest $request
|
||||||
|
@@ -45,6 +45,9 @@ class PreferencesController extends Controller
|
|||||||
public const RESOURCE_KEY = 'preferences';
|
public const RESOURCE_KEY = 'preferences';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/preferences/listPreference
|
||||||
|
*
|
||||||
* List all of them.
|
* List all of them.
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
@@ -75,6 +78,9 @@ class PreferencesController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/preferences/getPreference
|
||||||
|
*
|
||||||
* Return a single preference by name.
|
* Return a single preference by name.
|
||||||
*
|
*
|
||||||
* @param Preference $preference
|
* @param Preference $preference
|
||||||
@@ -95,6 +101,9 @@ class PreferencesController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/preferences/storePreference
|
||||||
|
*
|
||||||
* @param PreferenceStoreRequest $request
|
* @param PreferenceStoreRequest $request
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
@@ -116,6 +125,9 @@ class PreferencesController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/preferences/updatePreference
|
||||||
|
*
|
||||||
* @param PreferenceUpdateRequest $request
|
* @param PreferenceUpdateRequest $request
|
||||||
* @param Preference $preference
|
* @param Preference $preference
|
||||||
*
|
*
|
||||||
|
@@ -61,6 +61,9 @@ class AttemptController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/getWebhookMessageAttempts
|
||||||
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
* @param WebhookMessage $message
|
* @param WebhookMessage $message
|
||||||
*
|
*
|
||||||
@@ -94,6 +97,9 @@ class AttemptController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/getSingleWebhookMessageAttempt
|
||||||
|
*
|
||||||
* Show single instance.
|
* Show single instance.
|
||||||
*
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
|
@@ -56,6 +56,9 @@ class DestroyController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/deleteWebhook
|
||||||
|
*
|
||||||
* Remove the specified resource from storage.
|
* Remove the specified resource from storage.
|
||||||
*
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
@@ -71,6 +74,9 @@ class DestroyController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This webhook is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/deleteWebhookMessageAttempt
|
||||||
|
*
|
||||||
* Remove the specified resource from storage.
|
* Remove the specified resource from storage.
|
||||||
*
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
@@ -97,6 +103,9 @@ class DestroyController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/deleteWebhookMessage
|
||||||
|
*
|
||||||
* Remove the specified resource from storage.
|
* Remove the specified resource from storage.
|
||||||
*
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
|
@@ -57,6 +57,9 @@ class MessageController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/getWebhookMessages
|
||||||
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
@@ -86,6 +89,9 @@ class MessageController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/getSingleWebhookMessage
|
||||||
|
*
|
||||||
* Show single instance.
|
* Show single instance.
|
||||||
*
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
|
@@ -59,6 +59,9 @@ class ShowController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/listWebhook
|
||||||
|
*
|
||||||
* Display a listing of the webhooks of the user.
|
* Display a listing of the webhooks of the user.
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
@@ -88,6 +91,9 @@ class ShowController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/getWebhook
|
||||||
|
*
|
||||||
* Show single instance.
|
* Show single instance.
|
||||||
*
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
|
@@ -55,6 +55,9 @@ class StoreController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/storeWebhook
|
||||||
|
*
|
||||||
* @param CreateRequest $request
|
* @param CreateRequest $request
|
||||||
*
|
*
|
||||||
* @return JsonResponse
|
* @return JsonResponse
|
||||||
|
@@ -53,6 +53,9 @@ class SubmitController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/submitWebook
|
||||||
|
*
|
||||||
* Remove the specified resource from storage.
|
* Remove the specified resource from storage.
|
||||||
*
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
|
@@ -55,6 +55,9 @@ class UpdateController extends Controller
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This endpoint is documented at:
|
||||||
|
* https://api-docs.firefly-iii.org/#/webhooks/updateWebhook
|
||||||
|
*
|
||||||
* @param Webhook $webhook
|
* @param Webhook $webhook
|
||||||
* @param UpdateRequest $request
|
* @param UpdateRequest $request
|
||||||
*
|
*
|
||||||
|
Reference in New Issue
Block a user