From 43e096b1531d27b448a07172c348a08697e9fd19 Mon Sep 17 00:00:00 2001 From: Constantin Graf Date: Tue, 16 Apr 2024 16:54:03 +0200 Subject: [PATCH] Updated readme and docs --- README.md | 6 +++--- app/Http/Controllers/Api/V1/ProjectController.php | 2 +- app/Http/Controllers/Api/V1/TimeEntryController.php | 5 ++++- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b05a1645..9c70c4dc 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# solidtime +# solidtime - The modern Open-Source Time Tracker -![GitHub License](https://img.shields.io/github/license/solidtime-io/solidtime) +![GitHub License](https://img.shields.io/github/license/solidtime-io/solidtime?style=flat-square) ![Codecov](https://img.shields.io/codecov/c/github/solidtime-io/solidtime?style=flat-square&logo=codecov) ![GitHub Actions Unit Tests Status](https://img.shields.io/github/actions/workflow/status/solidtime-io/solidtime/phpunit.yml?style=flat-square) -![PHPStan badge](https://img.shields.io/badge/PHPstan-Level_7-blue?style=flat-square&color=blue) +![PHPStan badge](https://img.shields.io/badge/PHPStan-Level_7-blue?style=flat-square&color=blue) ![Screenshot of the solidtime application with header: solidtime - The modern Open-Source Time Tracker](docs/solidtime-banner.png "solidtime Banner") diff --git a/app/Http/Controllers/Api/V1/ProjectController.php b/app/Http/Controllers/Api/V1/ProjectController.php index e4d292c1..b745bb85 100644 --- a/app/Http/Controllers/Api/V1/ProjectController.php +++ b/app/Http/Controllers/Api/V1/ProjectController.php @@ -27,7 +27,7 @@ class ProjectController extends Controller } /** - * Get projects + * Get projects visible to the current user * * @return ProjectCollection * diff --git a/app/Http/Controllers/Api/V1/TimeEntryController.php b/app/Http/Controllers/Api/V1/TimeEntryController.php index 32e1c723..0cc18df2 100644 --- a/app/Http/Controllers/Api/V1/TimeEntryController.php +++ b/app/Http/Controllers/Api/V1/TimeEntryController.php @@ -31,7 +31,10 @@ class TimeEntryController extends Controller } /** - * Get time entries + * Get all time entries in organization + * + * If you only need time entries for a specific user, you can filter by `user_id`. + * Users with the permission `time-entries:view:own` can only use this endpoint with their own user ID in the user_id filter. * * @throws AuthorizationException *