mirror of
https://github.com/plankanban/planka.git
synced 2025-12-28 09:15:02 +03:00
docs: Add base path for API endpoints to Swagger
This commit is contained in:
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/users:
|
||||
* /users:
|
||||
* post:
|
||||
* summary: Create user
|
||||
* description: Creates a user account. Requires admin privileges.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user