Use id instead of username (#243)

Author: tchapi

README.md

@@ -579,7 +579,7 @@ If you change or add translations, you need to update the `messages` XLIFF file
 
 You can use:
 
-    ./bin/phpunit
+    ./vendor/bin/phpunit
 
 ## ✨ Code linting
 

docs/api/README.md

@@ -19,17 +19,17 @@ When `API_KEY` is not set, the API endpoints are disabled and will return a 500
 Each endpoint displays information related to the User:
 
 * [Get Users](v1/users/all.md) : `GET /api/v1/users`
-* [Get User Details](v1/users/details.md) : `GET /api/v1/users/:username`
+* [Get User Details](v1/users/details.md) : `GET /api/v1/users/:user_id`
 
 #### Calendars related
 
 Endpoints for viewing and modifying user calendars.
 
-* [Show All User Calendars](v1/calendars/all.md) : `GET /api/v1/calendars/:username`
-* [Show User Calendar Details](v1/calendars/details.md) : `GET /api/v1/calendars/:username/:calendar_id`
-* [Create User Calendar](v1/calendars/create.md) : `POST /api/v1/calendars/:username/create`
-* [Edit User Calendar](v1/calendars/edit.md) : `POST /api/v1/calendars/:username/:calendar_id/edit`
-* [Delete User Calendar](v1/calendars/delete.md) : `POST /api/v1/calendars/:username/:calendar_id/delete`
-* [Show User Calendar Shares](v1/calendars/shares.md) : `GET /api/v1/calendars/:username/shares/:calendar_id`
-* [Share User Calendar](v1/calendars/share_add.md) : `POST /api/v1/calendars/:username/share/:calendar_id/add`
-* [Remove Share User Calendar](v1/calendars/share_remove.md) : `POST /api/v1/calendars/:username/share/:calendar_id/remove`
+* [Show All User Calendars](v1/calendars/all.md) : `GET /api/v1/calendars/:user_id`
+* [Show User Calendar Details](v1/calendars/details.md) : `GET /api/v1/calendars/:user_id/:calendar_id`
+* [Create User Calendar](v1/calendars/create.md) : `POST /api/v1/calendars/:user_id/create`
+* [Edit User Calendar](v1/calendars/edit.md) : `PUT /api/v1/calendars/:user_id/:calendar_id`
+* [Delete User Calendar](v1/calendars/delete.md) : `DELETE /api/v1/calendars/:user_id/:calendar_id`
+* [Show User Calendar Shares](v1/calendars/shares.md) : `GET /api/v1/calendars/:user_id/shares/:calendar_id`
+* [Share User Calendar](v1/calendars/share_add.md) : `POST /api/v1/calendars/:user_id/share/:calendar_id/add`
+* [Remove Share User Calendar](v1/calendars/share_remove.md) : `POST /api/v1/calendars/:user_id/share/:calendar_id/remove`

docs/api/v1/calendars/all.md

@@ -2,7 +2,7 @@
 
 Gets a list of all available calendars for a specific user.
 
-**URL** : `/api/v1/calendars/:username`
+**URL** : `/api/v1/calendars/:user_id`
 
 **Method** : `GET`
 
@@ -11,7 +11,7 @@ Gets a list of all available calendars for a specific user.
 **Params constraints**
 
 ```
-:username -> "[username in plain text]",
+:user_id -> "[user id as an int]",
 ```
 
 **URL example**

docs/api/v1/calendars/create.md

@@ -2,7 +2,7 @@
 
 Creates a new calendar for a specific user.
 
-**URL** : `/api/v1/calendars/:username/create`
+**URL** : `/api/v1/calendars/:user_id/create`
 
 **Method** : `POST`
 
@@ -11,7 +11,7 @@ Creates a new calendar for a specific user.
 **Params constraints**
 
 ```
-:username -> "[username in plain text]",
+:user_id -> "[user id as an int]",
 ```
 
 **Request Body constraints**

docs/api/v1/calendars/delete.md

@@ -2,23 +2,23 @@
 
 Deletes a specific calendar for a specific user.
 
-**URL** : `/api/v1/calendars/:username/:calendar_id/delete`
+**URL** : `/api/v1/calendars/:user_id/:calendar_id`
 
-**Method** : `POST`
+**Method** : `DELETE`
 
 **Auth required** : YES
 
 **Params constraints**
 
 ```
-:username -> "[username in plain text]",
+:user_id -> "[user id as an int]",
 :calendar_id -> "[numeric id of a calendar owned by the user]",
 ```
 
 **URL example**
 
 ```
-/api/v1/calendars/jdoe/1/delete
+/api/v1/calendars/jdoe/1
 ```
 
 ## Success Response

docs/api/v1/calendars/details.md

@@ -2,7 +2,7 @@
 
 Gets a list of all available calendars for a specific user.
 
-**URL** : `/api/v1/calendars/:username/:calendar_id`
+**URL** : `/api/v1/calendars/:user_id/:calendar_id`
 
 **Method** : `GET`
 
@@ -11,7 +11,7 @@ Gets a list of all available calendars for a specific user.
 **Params constraints**
 
 ```
-:username -> "[username in plain text]",
+:user_id -> "[user id as an int]",
 :calendar_id -> "[numeric id of a calendar owned by the user]",
 ```
 

docs/api/v1/calendars/edit.md

@@ -2,16 +2,16 @@
 
 Edits an existing calendar for a specific user.
 
-**URL** : `/api/v1/calendars/:username/:calendar_id/edit`
+**URL** : `/api/v1/calendars/:user_id/:calendar_id`
 
-**Method** : `POST`
+**Method** : `PUT` or `PATCH`
 
 **Auth required** : YES
 
 **Params constraints**
 
 ```
-:username -> "[username in plain text]",
+:user_id -> "[user id as an int]",
 :calendar_id -> "[numeric id of a calendar owned by the user]",
 ```
 
@@ -30,7 +30,7 @@ Edits an existing calendar for a specific user.
 **URL example**
 
 ```
-/api/v1/calendars/jdoe/1/edit
+/api/v1/calendars/jdoe/1
 ```
 
 **Body example**

docs/api/v1/calendars/share_add.md

@@ -2,7 +2,7 @@
 
 Shares (or updates write access) a calendar owned by the specified user to another user.
 
-**URL** : `/api/v1/calendars/:username/share/:calendar_id/add`
+**URL** : `/api/v1/calendars/:user_id/share/:calendar_id/add`
 
 **Method** : `POST`
 
@@ -11,7 +11,7 @@ Shares (or updates write access) a calendar owned by the specified user to anoth
 **Params constraints**
 
 ```
-:username -> "[username in plain text]",
+:user_id -> "[user id as an int]",
 :calendar_id -> "[numeric id of a calendar owned by the user]",
 ```
 

docs/api/v1/calendars/share_remove.md

@@ -2,7 +2,7 @@
 
 Removes access to a specific shared calendar for a specific user.
 
-**URL** : `/api/v1/calendars/:username/share/:calendar_id/remove`
+**URL** : `/api/v1/calendars/:user_id/share/:calendar_id/remove`
 
 **Method** : `POST`
 
@@ -11,7 +11,7 @@ Removes access to a specific shared calendar for a specific user.
 **Params constraints**
 
 ```
-:username -> "[username in plain text]",
+:user_id -> "[user id as an int]",
 :calendar_id -> "[numeric id of a calendar owned by the user]",
 ```
 

docs/api/v1/calendars/shares.md

@@ -2,7 +2,7 @@
 
 Gets a list of all users with whom a specific user calendar is shared.
 
-**URL** : `/api/v1/calendars/:username/shares/:calendar_id`
+**URL** : `/api/v1/calendars/:user_id/shares/:calendar_id`
 
 **Method** : `GET`
 
@@ -11,7 +11,7 @@ Gets a list of all users with whom a specific user calendar is shared.
 **Params constraints**
 
 ```
-:username -> "[username in plain text]",
+:user_id -> "[user id as an int]",
 :calendar_id -> "[numeric id of a calendar owned by the user]",
 ```
 
@@ -35,13 +35,15 @@ Gets a list of all users with whom a specific user calendar is shared.
 	"data": [
 		{
 			"username": "adoe",
+			"user_id": 5,
 			"principal_id": 9,
 			"displayname": "Aiden Doe",
 			"email": "adoe@example.org",
 			"write_access": false
 		},
 		{
 			"username": "jdoe",
+			"user_id": 4,
 			"principal_id": 3,
 			"displayname": "John Doe",
 			"email": "jdoe@example.org",
@@ -101,4 +103,4 @@ or
 	"message": "Invalid Calendar ID/Username",
 	"timestamp": "2026-01-23T15:01:33+01:00"
 }
-```
+```