diff --git a/app/Api/V1/Controllers/Search/AccountController.php b/app/Api/V1/Controllers/Search/AccountController.php index 6bb2441c92..bc7adc0965 100644 --- a/app/Api/V1/Controllers/Search/AccountController.php +++ b/app/Api/V1/Controllers/Search/AccountController.php @@ -59,6 +59,8 @@ class AccountController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/search/searchAccounts * @param Request $request * * @return JsonResponse|Response diff --git a/app/Api/V1/Controllers/Search/TransactionController.php b/app/Api/V1/Controllers/Search/TransactionController.php index 1916b8ba31..a2464313a3 100644 --- a/app/Api/V1/Controllers/Search/TransactionController.php +++ b/app/Api/V1/Controllers/Search/TransactionController.php @@ -39,6 +39,9 @@ use League\Fractal\Resource\Collection; class TransactionController extends Controller { /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/search/searchTransactions + * * @param Request $request * @param SearchInterface $searcher * diff --git a/app/Api/V1/Controllers/Summary/BasicController.php b/app/Api/V1/Controllers/Summary/BasicController.php index 86d72982e1..e596549bb9 100644 --- a/app/Api/V1/Controllers/Summary/BasicController.php +++ b/app/Api/V1/Controllers/Summary/BasicController.php @@ -87,6 +87,9 @@ class BasicController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/summary/getBasicSummary + * * @param DateRequest $request * * @return JsonResponse diff --git a/app/Api/V1/Controllers/System/AboutController.php b/app/Api/V1/Controllers/System/AboutController.php index 054c8fa0d8..8c2cf0995a 100644 --- a/app/Api/V1/Controllers/System/AboutController.php +++ b/app/Api/V1/Controllers/System/AboutController.php @@ -39,6 +39,9 @@ use League\Fractal\Resource\Item; class AboutController extends Controller { /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/about/getAbout + * * Returns system information. * * @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. * * @return JsonResponse diff --git a/app/Api/V1/Controllers/System/ConfigurationController.php b/app/Api/V1/Controllers/System/ConfigurationController.php index 885175837c..dce33eafbb 100644 --- a/app/Api/V1/Controllers/System/ConfigurationController.php +++ b/app/Api/V1/Controllers/System/ConfigurationController.php @@ -54,6 +54,9 @@ class ConfigurationController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/configuration/getConfiguration + * * @return JsonResponse * @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 * * @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. * * @param UpdateRequest $request diff --git a/app/Api/V1/Controllers/System/CronController.php b/app/Api/V1/Controllers/System/CronController.php index c33373f240..aac11c2447 100644 --- a/app/Api/V1/Controllers/System/CronController.php +++ b/app/Api/V1/Controllers/System/CronController.php @@ -37,6 +37,9 @@ class CronController extends Controller use CronRunner; /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/about/getCron + * * @param CronRequest $request * @param string $token * diff --git a/app/Api/V1/Controllers/System/UserController.php b/app/Api/V1/Controllers/System/UserController.php index 368359afe9..536f0bc6ba 100644 --- a/app/Api/V1/Controllers/System/UserController.php +++ b/app/Api/V1/Controllers/System/UserController.php @@ -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. * * @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. * * @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. * * @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. * * @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. * * @param UserUpdateRequest $request diff --git a/app/Api/V1/Controllers/User/PreferencesController.php b/app/Api/V1/Controllers/User/PreferencesController.php index f9cced2fe4..2eb2533c0d 100644 --- a/app/Api/V1/Controllers/User/PreferencesController.php +++ b/app/Api/V1/Controllers/User/PreferencesController.php @@ -45,6 +45,9 @@ class PreferencesController extends Controller public const RESOURCE_KEY = 'preferences'; /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/preferences/listPreference + * * List all of them. * * @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. * * @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 * * @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 Preference $preference * diff --git a/app/Api/V1/Controllers/Webhook/AttemptController.php b/app/Api/V1/Controllers/Webhook/AttemptController.php index 775821dbbd..eaad374f1a 100644 --- a/app/Api/V1/Controllers/Webhook/AttemptController.php +++ b/app/Api/V1/Controllers/Webhook/AttemptController.php @@ -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 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. * * @param Webhook $webhook diff --git a/app/Api/V1/Controllers/Webhook/DestroyController.php b/app/Api/V1/Controllers/Webhook/DestroyController.php index 8832c342ea..8bee3a7d34 100644 --- a/app/Api/V1/Controllers/Webhook/DestroyController.php +++ b/app/Api/V1/Controllers/Webhook/DestroyController.php @@ -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. * * @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. * * @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. * * @param Webhook $webhook diff --git a/app/Api/V1/Controllers/Webhook/MessageController.php b/app/Api/V1/Controllers/Webhook/MessageController.php index e98d9a05a5..e6ee8a1c5d 100644 --- a/app/Api/V1/Controllers/Webhook/MessageController.php +++ b/app/Api/V1/Controllers/Webhook/MessageController.php @@ -57,6 +57,9 @@ class MessageController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/webhooks/getWebhookMessages + * * @param Webhook $webhook * * @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. * * @param Webhook $webhook diff --git a/app/Api/V1/Controllers/Webhook/ShowController.php b/app/Api/V1/Controllers/Webhook/ShowController.php index cfa77aef1e..6baa755cd3 100644 --- a/app/Api/V1/Controllers/Webhook/ShowController.php +++ b/app/Api/V1/Controllers/Webhook/ShowController.php @@ -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. * * @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. * * @param Webhook $webhook diff --git a/app/Api/V1/Controllers/Webhook/StoreController.php b/app/Api/V1/Controllers/Webhook/StoreController.php index ffd6c292d0..933b7331dd 100644 --- a/app/Api/V1/Controllers/Webhook/StoreController.php +++ b/app/Api/V1/Controllers/Webhook/StoreController.php @@ -55,6 +55,9 @@ class StoreController extends Controller } /** + * This endpoint is documented at: + * https://api-docs.firefly-iii.org/#/webhooks/storeWebhook + * * @param CreateRequest $request * * @return JsonResponse diff --git a/app/Api/V1/Controllers/Webhook/SubmitController.php b/app/Api/V1/Controllers/Webhook/SubmitController.php index 7ed448636e..989a118b26 100644 --- a/app/Api/V1/Controllers/Webhook/SubmitController.php +++ b/app/Api/V1/Controllers/Webhook/SubmitController.php @@ -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. * * @param Webhook $webhook diff --git a/app/Api/V1/Controllers/Webhook/UpdateController.php b/app/Api/V1/Controllers/Webhook/UpdateController.php index bb245102e7..2ac56df45d 100644 --- a/app/Api/V1/Controllers/Webhook/UpdateController.php +++ b/app/Api/V1/Controllers/Webhook/UpdateController.php @@ -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 UpdateRequest $request *