kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-04 03:43:07 +00:00
Code Issues Projects Releases Wiki Activity

Add endpoint links.

Browse Source
This commit is contained in:
James Cole
2021-09-19 17:22:16 +02:00
parent 1efbbe4b84
commit 915f4a0045
15 changed files with 89 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/Api/V1/Controllers/Search/AccountController.php
View File

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

3
app/Api/V1/Controllers/Search/TransactionController.php
View File

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

3
app/Api/V1/Controllers/Summary/BasicController.php
View File

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

6
app/Api/V1/Controllers/System/AboutController.php
View File

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

9
app/Api/V1/Controllers/System/ConfigurationController.php
View File

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

3
app/Api/V1/Controllers/System/CronController.php
View File

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

15
app/Api/V1/Controllers/System/UserController.php
View File

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

12
app/Api/V1/Controllers/User/PreferencesController.php
View File

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

6
app/Api/V1/Controllers/Webhook/AttemptController.php
View File

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

9
app/Api/V1/Controllers/Webhook/DestroyController.php
View File

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

6
app/Api/V1/Controllers/Webhook/MessageController.php
View File

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

6
app/Api/V1/Controllers/Webhook/ShowController.php
View File

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

3
app/Api/V1/Controllers/Webhook/StoreController.php
View File

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

3
app/Api/V1/Controllers/Webhook/SubmitController.php
View File

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

3
app/Api/V1/Controllers/Webhook/UpdateController.php
View File

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