jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

API: changed date-format, camelCase instead of snake_case, null values, update and create for customer and project (#718)

Browse Source
This commit is contained in:
Kevin Papst
2019-04-24 18:13:33 +02:00
committed by GitHub
parent 215d4fc8bf
commit 460391136f
61 changed files with 2304 additions and 505 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
src/API/ActivityController.php
View File

@@ -24,6 +24,7 @@ use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
use Swagger\Annotations as SWG;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
/**
* @RouteResource("Activity")
@@ -53,20 +54,22 @@ class ActivityController extends BaseApiController
}
/**
* Returns a collection of activities
*
* @SWG\Response(
* response=200,
* description="Returns the collection of all existing activities",
* description="Returns a collection of activity entities",
* @SWG\Schema(
* type="array",
* @SWG\Items(ref="#/definitions/ActivityEntity")
* @SWG\Items(ref="#/definitions/ActivityCollection")
* )
* )
* @Rest\QueryParam(name="project", requirements="\d+", strict=true, nullable=true, description="Project ID to filter activities. If none is provided, only global activities will be returned.")
* @Rest\QueryParam(name="visible", requirements="\d+", strict=true, nullable=true, description="Visibility status to filter activities (1=visible, 2=hidden, 3=both)")
* @Rest\QueryParam(name="globals", requirements="true", strict=true, nullable=true, description="Pass 'true' as string to fetch only global activities")
* @Rest\QueryParam(name="globalsFirst", requirements="false", strict=true, nullable=true, description="Pass 'false' as string if you don't want the global activities to be listed first")
* @Rest\QueryParam(name="order", requirements="ASC|DESC", strict=true, nullable=true, description="The result order (allowed values: 'ASC', 'DESC')")
* @Rest\QueryParam(name="orderBy", requirements="id|name|project", strict=true, nullable=true, description="The field by which results will be ordered (allowed values: 'id', 'name', 'project')")
* @Rest\QueryParam(name="project", requirements="\d+", strict=true, nullable=true, description="Project ID to filter activities. If none is provided, all activities will be returned.")
* @Rest\QueryParam(name="visible", requirements="1|2|3", strict=true, nullable=true, description="Visibility status to filter activities. Allowed values: 1=visible, 2=hidden, 3=all (default: 1)")
* @Rest\QueryParam(name="globals", requirements="true", strict=true, nullable=true, description="Use if you want to fetch only global activities. Allowed values: true (default: false)")
* @Rest\QueryParam(name="globalsFirst", requirements="false", strict=true, nullable=true, description="Use if you don't want global activities to be listed first. Allowed values: false (default: true)")
* @Rest\QueryParam(name="orderBy", requirements="id|name|project", strict=true, nullable=true, description="The field by which results will be ordered. Allowed values: id, name, project (default: name)")
* @Rest\QueryParam(name="order", requirements="ASC|DESC", strict=true, nullable=true, description="The result order. Allowed values: ASC, DESC (default: ASC)")
*
* @return Response
*/
@@ -110,11 +113,20 @@ class ActivityController extends BaseApiController
}
/**
* Returns one activity
*
* @SWG\Response(
* response=200,
* description="Returns one activity entity",
* @SWG\Schema(ref="#/definitions/ActivityEntity"),
* )
* @SWG\Parameter(
* name="id",
* in="path",
* type="integer",
* description="Activity ID to fetch",
* required=true,
* )
*
* @param int $id
* @return Response
@@ -122,9 +134,11 @@ class ActivityController extends BaseApiController
public function getAction($id)
{
$data = $this->repository->find($id);
if (null === $data) {
throw new NotFoundException();
}
$view = new View($data, 200);
$view->getContext()->setGroups(['Default', 'Entity', 'Activity']);
@@ -132,11 +146,13 @@ class ActivityController extends BaseApiController
}
/**
* Creates a new activity
*
* @SWG\Post(
* description="Creates a new activity entry and returns it afterwards",
* description="Creates a new activity and returns it afterwards",
* @SWG\Response(
* response=200,
* description="Returns the new created activity entry",
* description="Returns the new created activity",
* @SWG\Schema(ref="#/definitions/ActivityEntity"),
* )
* )
@@ -156,7 +172,7 @@ class ActivityController extends BaseApiController
public function postAction(Request $request)
{
if (!$this->isGranted('create_activity')) {
throw $this->createAccessDeniedException('User cannot create activities');
throw new AccessDeniedHttpException('User cannot create activities');
}
$activity = new Activity();
@@ -168,10 +184,6 @@ class ActivityController extends BaseApiController
$form->submit($request->request->all());
if ($form->isValid()) {
if (null !== $activity->getId()) {
return new Response('This method does not support updates', Response::HTTP_BAD_REQUEST);
}
$entityManager = $this->getDoctrine()->getManager();
$entityManager->persist($activity);
$entityManager->flush();
@@ -189,11 +201,13 @@ class ActivityController extends BaseApiController
}
/**
* Update an existing activity
*
* @SWG\Patch(
* description="Update an existing activity entry, you can pass all or just a subset of all attributes",
* description="Update an existing activity, you can pass all or just a subset of all attributes",
* @SWG\Response(
* response=200,
* description="Returns the updated activity entry",
* description="Returns the updated activity",
* @SWG\Schema(ref="#/definitions/ActivityEntity")
* )
* )
@@ -203,6 +217,13 @@ class ActivityController extends BaseApiController
* required=true,
* @SWG\Schema(ref="#/definitions/ActivityEditForm")
* )
* @SWG\Parameter(
* name="id",
* in="path",
* type="integer",
* description="Activity ID to update",
* required=true,
* )
*
* @param Request $request
* @param string $id
@@ -212,8 +233,12 @@ class ActivityController extends BaseApiController
{
$activity = $this->repository->find($id);
if (null === $activity) {
throw new NotFoundException();
}
if (!$this->isGranted('edit', $activity)) {
throw $this->createAccessDeniedException('User cannot update activity');
throw new AccessDeniedHttpException('User cannot update activity');
}
$form = $this->createForm(ActivityEditForm::class, $activity, [