mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2026-01-10 04:21:20 +00:00
Add endpoint links.
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
*
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user