mirror of
https://github.com/plankanban/planka.git
synced 2025-12-24 09:15:01 +03:00
docs: Improve Swagger JSDoc
This commit is contained in:
@@ -11,6 +11,7 @@
|
||||
* description: Creates a user account. Requires admin privileges.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: createUser
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Deletes a user account. Cannot delete the default admin user. Requires admin privileges.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: deleteUser
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Retrieves a list of all users. Requires admin or project owner privileges.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: getUsers
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of users retrieved successfully
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Retrieves a user. Use 'me' as ID to get the current user.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: getUser
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Updates a user's avatar image. Users can update their own avatar, admins can update any user's avatar.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: updateUserAvatar
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* 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.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: updateUserEmail
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* 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.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: updateUserPassword
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
@@ -60,7 +61,7 @@
|
||||
* description: New acces tokens (when updating own password)
|
||||
* items:
|
||||
* type: string
|
||||
* example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ4...
|
||||
* example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ4...
|
||||
* 400:
|
||||
* $ref: '#/components/responses/ValidationError'
|
||||
* 401:
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* 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.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: updateUserUsername
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
* description: Updates a user. Users can update their own profile, admins can update any user.
|
||||
* tags:
|
||||
* - Users
|
||||
* operationId: updateUser
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
@@ -40,6 +41,7 @@
|
||||
* type: object
|
||||
* nullable: true
|
||||
* description: Avatar of the user (only null value to remove avatar)
|
||||
* example: null
|
||||
* phone:
|
||||
* type: string
|
||||
* maxLength: 128
|
||||
|
||||
Reference in New Issue
Block a user