Update API endpoints.

This commit is contained in:
James Cole 2021-09-18 10:07:45 +02:00
parent d18e9da468
commit b3a98d7079
No known key found for this signature in database
GPG Key ID: BDE6667570EADBD5
11 changed files with 52 additions and 4 deletions

View File

@ -56,6 +56,9 @@ class DestroyController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/accounts/deleteAccount
*
* Remove the specified resource from storage.
*
* @param Account $account

View File

@ -24,6 +24,7 @@ declare(strict_types=1);
namespace FireflyIII\Api\V1\Controllers\Models\Account;
use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
use FireflyIII\Models\Account;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
@ -69,11 +70,14 @@ class ListController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/accounts/listAttachmentByAccount
*
* @param Account $account
*
* @return JsonResponse
* @throws \FireflyIII\Exceptions\FireflyException
* @codeCoverageIgnore
* @throws FireflyException
*/
public function attachments(Account $account): JsonResponse
{
@ -99,12 +103,13 @@ class ListController extends Controller
}
/**
* List all piggies.
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/accounts/listPiggyBankByAccount
*
* @param Account $account
*
* @return JsonResponse
* @throws \FireflyIII\Exceptions\FireflyException
* @throws FireflyException
* @codeCoverageIgnore
*/
public function piggyBanks(Account $account): JsonResponse
@ -136,6 +141,9 @@ class ListController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/accounts/listTransactionByAccount
*
* Show all transaction groups related to the account.
*
* @codeCoverageIgnore

View File

@ -65,6 +65,9 @@ class ShowController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/accounts/listAccount
*
* Display a listing of the resource.
*
* @param Request $request
@ -108,6 +111,9 @@ class ShowController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/accounts/getAccount
*
* Show single instance.
*
* @param Account $account

View File

@ -58,6 +58,9 @@ class StoreController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/accounts/storeAccount
*
* Store a new instance.
*
* @param StoreRequest $request

View File

@ -61,6 +61,9 @@ class UpdateController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/accounts/updateAccount
*
* Update account.
*
* @param UpdateRequest $request

View File

@ -59,6 +59,9 @@ class DestroyController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/attachments/deleteAttachment
*
* Remove the specified resource from storage.
*
* @codeCoverageIgnore

View File

@ -66,6 +66,9 @@ class ShowController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/attachments/downloadAttachment
*
* Download an attachment.
*
* @param Attachment $attachment
@ -108,6 +111,9 @@ class ShowController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/attachments/listAttachment
*
* Display a listing of the resource.
*
* @return JsonResponse
@ -141,6 +147,9 @@ class ShowController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/attachments/getAttachment
*
* Display the specified resource.
*
* @param Attachment $attachment

View File

@ -66,6 +66,9 @@ class StoreController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/attachments/uploadAttachment
*
* Store a newly created resource in storage.
*
* @param StoreRequest $request

View File

@ -62,6 +62,9 @@ class UpdateController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/attachments/updateAttachment
*
* Update the specified resource in storage.
*
* @param UpdateRequest $request

View File

@ -57,6 +57,9 @@ class DestroyController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/available_budgets/listAvailableBudget
*
* Remove the specified resource from storage.
*
* @param AvailableBudget $availableBudget

View File

@ -24,6 +24,7 @@ declare(strict_types=1);
namespace FireflyIII\Api\V1\Controllers\Models\AvailableBudget;
use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\AvailableBudget;
use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
use FireflyIII\Transformers\AvailableBudgetTransformer;
@ -62,10 +63,13 @@ class ShowController extends Controller
}
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/#/available_budgets/getAvailableBudget
*
* Display a listing of the resource.
*
* @return JsonResponse
* @throws \FireflyIII\Exceptions\FireflyException
* @throws FireflyException
* @codeCoverageIgnore
*/
public function index(): JsonResponse