docs: Add base path for API endpoints to Swagger

This commit is contained in:
Maksim Eltyshev
2025-09-08 18:25:26 +02:00
parent 68549d0da8
commit 5636cf27c0
99 changed files with 104 additions and 98 deletions

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users:
* /users:
* post:
* summary: Create user
* description: Creates a user account. Requires admin privileges.

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users/{id}:
* /users/{id}:
* delete:
* summary: Delete user
* description: Deletes a user account. Cannot delete the default admin user. Requires admin privileges.

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users:
* /users:
* get:
* summary: Get all users
* description: Retrieves a list of all users. Requires admin or project owner privileges.

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users/{id}:
* /users/{id}:
* get:
* summary: Get user details
* description: Retrieves a user. Use 'me' as ID to get the current user.

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users/{id}/avatar:
* /users/{id}/avatar:
* patch:
* summary: Update user avatar
* description: Updates a user's avatar image. Users can update their own avatar, admins can update any user's avatar.

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users/{id}/email:
* /users/{id}/email:
* patch:
* summary: Update user email
* description: Updates a user's email address. Users must provide current password when updating their own email. Admins can update any user's email without a password.

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users/{id}/password:
* /users/{id}/password:
* patch:
* summary: Update user password
* description: Updates a user's password. Users must provide a current password when updating their own password. Admins can update any user's password without the current password. Returns a new access token when updating own password.

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users/{id}/username:
* /users/{id}/username:
* patch:
* summary: Update user username
* description: Updates a user's username. Users must provide a current password when updating their own username (unless they are SSO users with `oidcIgnoreUsername` enabled). Admins can update any user's username without the current password.

View File

@@ -5,7 +5,7 @@
/**
* @swagger
* /api/users/{id}:
* /users/{id}:
* patch:
* summary: Update user
* description: Updates a user. Users can update their own profile, admins can update any user.