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 * @swagger
* /api/access-tokens/accept-terms: * /access-tokens/accept-terms:
* post: * post:
* summary: Accept terms and conditions * summary: Accept terms and conditions
* description: Accept terms during the authentication flow. Converts the pending token to an access token. * description: Accept terms during the authentication flow. Converts the pending token to an access token.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/access-tokens: * /access-tokens:
* post: * post:
* summary: User login * summary: User login
* description: Authenticates a user using email/username and password. Returns an access token for API authentication. * description: Authenticates a user using email/username and password. Returns an access token for API authentication.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/access-tokens: * /access-tokens:
* delete: * delete:
* summary: User logout * summary: User logout
* description: Logs out the current user by deleting the session and access token. Clears HTTP-only cookies if present. * description: Logs out the current user by deleting the session and access token. Clears HTTP-only cookies if present.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/access-tokens/exchange-with-oidc: * /access-tokens/exchange-with-oidc:
* post: * post:
* summary: Exchange OIDC code for access token * summary: Exchange OIDC code for access token
* description: Exchanges an OIDC authorization code for an access token. Creates a user if they do not exist. * description: Exchanges an OIDC authorization code for an access token. Creates a user if they do not exist.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/access-tokens/revoke-pending-token: * /access-tokens/revoke-pending-token:
* post: * post:
* summary: Revoke pending token * summary: Revoke pending token
* description: Revokes a pending authentication token and cancels the authentication flow. * description: Revokes a pending authentication token and cancels the authentication flow.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{boardId}/actions: * /boards/{boardId}/actions:
* get: * get:
* summary: Get board actions * summary: Get board actions
* description: Retrieves a list of actions (activity history) for a specific board, with pagination support. * description: Retrieves a list of actions (activity history) for a specific board, with pagination support.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/actions: * /cards/{cardId}/actions:
* get: * get:
* summary: Get card actions * summary: Get card actions
* description: Retrieves a list of actions (activity history) for a specific card, with pagination support. * description: Retrieves a list of actions (activity history) for a specific card, with pagination support.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/attachments: * /cards/{cardId}/attachments:
* post: * post:
* summary: Create attachment * summary: Create attachment
* description: Creates an attachment on a card. Requires board editor permissions. * description: Creates an attachment on a card. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/attachments/{id}: * /attachments/{id}:
* delete: * delete:
* summary: Delete attachment * summary: Delete attachment
* description: Deletes an attachment. Requires board editor permissions. * description: Deletes an attachment. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/attachments/{id}: * /attachments/{id}:
* patch: * patch:
* summary: Update attachment * summary: Update attachment
* description: Updates an attachment. Requires board editor permissions. * description: Updates an attachment. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects/{projectId}/background-images: * /projects/{projectId}/background-images:
* post: * post:
* summary: Upload background image * summary: Upload background image
* description: Uploads a background image for a project. Requires project manager permissions. * description: Uploads a background image for a project. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/background-images/{id}: * /background-images/{id}:
* delete: * delete:
* summary: Delete background image * summary: Delete background image
* description: Deletes a background image. Requires project manager permissions. * description: Deletes a background image. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects/{projectId}/base-custom-field-groups: * /projects/{projectId}/base-custom-field-groups:
* post: * post:
* summary: Create base custom field group * summary: Create base custom field group
* description: Creates a base custom field group within a project. Requires project manager permissions. * description: Creates a base custom field group within a project. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/base-custom-field-groups/{id}: * /base-custom-field-groups/{id}:
* delete: * delete:
* summary: Delete base custom field group * summary: Delete base custom field group
* description: Deletes a base custom field group. Requires project manager permissions. * description: Deletes a base custom field group. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/base-custom-field-groups/{id}: * /base-custom-field-groups/{id}:
* patch: * patch:
* summary: Update base custom field group * summary: Update base custom field group
* description: Updates a base custom field group. Requires project manager permissions. * description: Updates a base custom field group. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{boardId}/memberships: * /boards/{boardId}/memberships:
* post: * post:
* summary: Add user to board * summary: Add user to board
* description: Adds a user to a board. Requires project manager permissions. * description: Adds a user to a board. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/board-memberships/{id}: * /board-memberships/{id}:
* delete: * delete:
* summary: Remove user from board * summary: Remove user from board
* description: Removes a user from a board. Users can remove themselves, or project managers can remove any user. * description: Removes a user from a board. Users can remove themselves, or project managers can remove any user.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/board-memberships/{id}: * /board-memberships/{id}:
* patch: * patch:
* summary: Update board membership * summary: Update board membership
* description: Updates a board membership. Requires project manager permissions. * description: Updates a board membership. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects/{projectId}/boards: * /projects/{projectId}/boards:
* post: * post:
* summary: Create board * summary: Create board
* description: Creates a board within a project. Supports importing from Trello. Requires project manager permissions. * description: Creates a board within a project. Supports importing from Trello. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{id}: * /boards/{id}:
* delete: * delete:
* summary: Delete board * summary: Delete board
* description: Deletes a board and all its contents (lists, cards, etc.). Requires project manager permissions. * description: Deletes a board and all its contents (lists, cards, etc.). Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{id}: * /boards/{id}:
* get: * get:
* summary: Get board details * summary: Get board details
* description: Retrieves comprehensive board information, including lists, cards, and other related data. * description: Retrieves comprehensive board information, including lists, cards, and other related data.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{id}: * /boards/{id}:
* patch: * patch:
* summary: Update board * summary: Update board
* description: Updates a board. Project managers can update all fields, board members can only subscribe/unsubscribe. * description: Updates a board. Project managers can update all fields, board members can only subscribe/unsubscribe.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/labels: * /cards/{cardId}/labels:
* post: * post:
* summary: Add label to card * summary: Add label to card
* description: Adds a label to a card. Requires board editor permissions. * description: Adds a label to a card. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/labels/{labelId}: * /cards/{cardId}/labels/{labelId}:
* delete: * delete:
* summary: Remove label from card * summary: Remove label from card
* description: Removes a label from a card. Requires board editor permissions. * description: Removes a label from a card. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/memberships: * /cards/{cardId}/memberships:
* post: * post:
* summary: Add user to card * summary: Add user to card
* description: Adds a user to a card. Requires board editor permissions. * description: Adds a user to a card. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/memberships/{userId}: * /cards/{cardId}/memberships/{userId}:
* delete: * delete:
* summary: Remove user from card * summary: Remove user from card
* description: Removes a user from a card. Requires board editor permissions. * description: Removes a user from a card. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/lists/{listId}/cards: * /lists/{listId}/cards:
* post: * post:
* summary: Create card * summary: Create card
* description: Creates a card within a list. Requires board editor permissions. * description: Creates a card within a list. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{id}: * /cards/{id}:
* delete: * delete:
* summary: Delete card * summary: Delete card
* description: Deletes a card and all its contents (tasks, attachments, etc.). Requires board editor permissions. * description: Deletes a card and all its contents (tasks, attachments, etc.). Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{id}/duplicate: * /cards/{id}/duplicate:
* post: * post:
* summary: Duplicate card * summary: Duplicate card
* description: Creates a duplicate of a card with all its contents (tasks, attachments, etc.). Requires board editor permissions. * description: Creates a duplicate of a card with all its contents (tasks, attachments, etc.). Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/lists/{listId}/cards: * /lists/{listId}/cards:
* get: * get:
* summary: Get cards in list * summary: Get cards in list
* description: Retrieves cards from an endless list with filtering, search, and pagination support. * description: Retrieves cards from an endless list with filtering, search, and pagination support.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{id}/read-notifications: * /cards/{id}/read-notifications:
* post: * post:
* summary: Mark card notifications as read * summary: Mark card notifications as read
* description: Marks all notifications for a specific card as read for the current user. Requires access to the card. * description: Marks all notifications for a specific card as read for the current user. Requires access to the card.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{id}: * /cards/{id}:
* get: * get:
* summary: Get card details * summary: Get card details
* description: Retrieves comprehensive card information, including tasks, attachments, and other related data. * description: Retrieves comprehensive card information, including tasks, attachments, and other related data.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{id}: * /cards/{id}:
* patch: * patch:
* summary: Update card * summary: Update card
* description: Updates a card. Board editors can update all fields, viewers can only subscribe/unsubscribe. * description: Updates a card. Board editors can update all fields, viewers can only subscribe/unsubscribe.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/comments: * /cards/{cardId}/comments:
* post: * post:
* summary: Create comment * summary: Create comment
* description: Creates a new comment on a card. Requires board editor permissions or comment permissions. * description: Creates a new comment on a card. Requires board editor permissions or comment permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/comments/{id}: * /comments/{id}:
* delete: * delete:
* summary: Delete comment * summary: Delete comment
* description: Deletes a comment. Can be deleted by the comment author (with comment permissions) or project manager. * description: Deletes a comment. Can be deleted by the comment author (with comment permissions) or project manager.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/comments: * /cards/{cardId}/comments:
* get: * get:
* summary: Get card comments * summary: Get card comments
* description: Retrieves comments for a card with pagination support. Requires access to the card. * description: Retrieves comments for a card with pagination support. Requires access to the card.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/comments/{id}: * /comments/{id}:
* patch: * patch:
* summary: Update comment * summary: Update comment
* description: Updates a comment. Only the author of the comment can update it. * description: Updates a comment. Only the author of the comment can update it.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/config: * /config:
* get: * get:
* summary: Get application configuration * summary: Get application configuration
* description: Retrieves the application configuration. * description: Retrieves the application configuration.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{boardId}/custom-field-groups: * /boards/{boardId}/custom-field-groups:
* post: * post:
* summary: Create custom field group in board * summary: Create custom field group in board
* description: Creates a custom field group within a board. Either `baseCustomFieldGroupId` or `name` must be provided. Requires board editor permissions. * description: Creates a custom field group within a board. Either `baseCustomFieldGroupId` or `name` must be provided. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/custom-field-groups: * /cards/{cardId}/custom-field-groups:
* post: * post:
* summary: Create custom field group in card * summary: Create custom field group in card
* description: Creates a custom field group within a card. Either `baseCustomFieldGroupId` or `name` must be provided. Requires board editor permissions. * description: Creates a custom field group within a card. Either `baseCustomFieldGroupId` or `name` must be provided. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/custom-field-groups/{id}: * /custom-field-groups/{id}:
* delete: * delete:
* summary: Delete custom field group * summary: Delete custom field group
* description: Deletes a custom field group. Requires board editor permissions. * description: Deletes a custom field group. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/custom-field-groups/{id}: * /custom-field-groups/{id}:
* get: * get:
* summary: Get custom field group details * summary: Get custom field group details
* description: Retrieves comprehensive custom field group information, including fields and values. Requires access to the board/card. * description: Retrieves comprehensive custom field group information, including fields and values. Requires access to the board/card.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/custom-field-groups/{id}: * /custom-field-groups/{id}:
* patch: * patch:
* summary: Update custom field group * summary: Update custom field group
* description: Updates a custom field group. Supports both board-wide and card-specific groups. Requires board editor permissions. * description: Updates a custom field group. Supports both board-wide and card-specific groups. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/custom-field-values: * /cards/{cardId}/custom-field-values:
* post: * post:
* summary: Create or update custom field value * summary: Create or update custom field value
* description: Creates or updates a custom field value for a card. Requires board editor permissions. * description: Creates or updates a custom field value for a card. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/custom-field-groups/{customFieldGroupId}/custom-fields/{customFieldId}/value: * /cards/{cardId}/custom-field-groups/{customFieldGroupId}/custom-fields/{customFieldId}/value:
* delete: * delete:
* summary: Delete custom field value * summary: Delete custom field value
* description: Deletes a custom field value for a specific card. Requires board editor permissions. * description: Deletes a custom field value for a specific card. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/base-custom-field-groups/{baseCustomFieldGroupId}/custom-fields: * /base-custom-field-groups/{baseCustomFieldGroupId}/custom-fields:
* post: * post:
* summary: Create custom field in base custom field group * summary: Create custom field in base custom field group
* description: Creates a custom field within a base custom field group. Requires project manager permissions. * description: Creates a custom field within a base custom field group. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/custom-field-groups/{customFieldGroupId}/custom-fields: * /custom-field-groups/{customFieldGroupId}/custom-fields:
* post: * post:
* summary: Create custom field in custom field group * summary: Create custom field in custom field group
* description: Creates a custom field within a custom field group. Requires board editor permissions. * description: Creates a custom field within a custom field group. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/custom-fields/{id}: * /custom-fields/{id}:
* delete: * delete:
* summary: Delete custom field * summary: Delete custom field
* description: Deletes a custom field. Can delete the in base custom field group (requires project manager permissions) or the custom field group (requires board editor permissions). * description: Deletes a custom field. Can delete the in base custom field group (requires project manager permissions) or the custom field group (requires board editor permissions).

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/custom-fields/{id}: * /custom-fields/{id}:
* patch: * patch:
* summary: Update custom field * summary: Update custom field
* description: Updates a custom field. Can update in the base custom field group (requires project manager permissions) or the custom field group (requires board editor permissions). * description: Updates a custom field. Can update in the base custom field group (requires project manager permissions) or the custom field group (requires board editor permissions).

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/attachments/{id}/download/thumbnails/{fileName}.{fileExtension}: * /attachments/{id}/download/thumbnails/{fileName}.{fileExtension}:
* get: * get:
* summary: Download file attachment thumbnail * summary: Download file attachment thumbnail
* description: Downloads a thumbnail for a file attachment. Only available for image attachments that have thumbnails generated. Requires access to the card. * description: Downloads a thumbnail for a file attachment. Only available for image attachments that have thumbnails generated. Requires access to the card.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/attachments/{id}/download: * /attachments/{id}/download:
* get: * get:
* summary: Download file attachment * summary: Download file attachment
* description: Downloads a file attachment. Requires access to the card. * description: Downloads a file attachment. Requires access to the card.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{boardId}/labels: * /boards/{boardId}/labels:
* post: * post:
* summary: Create label * summary: Create label
* description: Creates a label within a board. Requires board editor permissions. * description: Creates a label within a board. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/labels/{id}: * /labels/{id}:
* delete: * delete:
* summary: Delete label * summary: Delete label
* description: Deletes a label. Requires board editor permissions. * description: Deletes a label. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/labels/{id}: * /labels/{id}:
* patch: * patch:
* summary: Update label * summary: Update label
* description: Updates a label. Requires board editor permissions. * description: Updates a label. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/lists/{id}/clear: * /lists/{id}/clear:
* post: * post:
* summary: Clear list * summary: Clear list
* description: Deletes all cards from a list. Only works with trash-type lists. Requires project manager or board editor permissions. * description: Deletes all cards from a list. Only works with trash-type lists. Requires project manager or board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{boardId}/lists: * /boards/{boardId}/lists:
* post: * post:
* summary: Create list * summary: Create list
* description: Creates a list within a board. Requires board editor permissions. * description: Creates a list within a board. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/lists/{id}: * /lists/{id}:
* delete: * delete:
* summary: Delete list * summary: Delete list
* description: Deletes a list and moves its cards to a trash list. Can only delete finite lists. Requires board editor permissions. * description: Deletes a list and moves its cards to a trash list. Can only delete finite lists. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/lists/{id}/move-cards: * /lists/{id}/move-cards:
* post: * post:
* summary: Move cards * summary: Move cards
* description: Moves all cards from a closed list to an archive list. Requires board editor permissions. * description: Moves all cards from a closed list to an archive list. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/lists/{id}: * /lists/{id}:
* get: * get:
* summary: Get list details * summary: Get list details
* description: Retrieves comprehensive list information, including cards, attachments, and other related data. Requires access to the board. * description: Retrieves comprehensive list information, including cards, attachments, and other related data. Requires access to the board.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/lists/{id}/sort: * /lists/{id}/sort:
* post: * post:
* summary: Sort cards in list * summary: Sort cards in list
* description: Sorts all cards within a list. Requires board editor permissions. * description: Sorts all cards within a list. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/lists/{id}: * /lists/{id}:
* patch: * patch:
* summary: Update list * summary: Update list
* description: Updates a list. Can move lists between boards. Requires board editor permissions. * description: Updates a list. Can move lists between boards. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/boards/{boardId}/notification-services: * /boards/{boardId}/notification-services:
* post: * post:
* summary: Create notification service for board * summary: Create notification service for board
* description: Creates a new notification service for a board. Requires project manager permissions. * description: Creates a new notification service for a board. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/users/{userId}/notification-services: * /users/{userId}/notification-services:
* post: * post:
* summary: Create notification service for user * summary: Create notification service for user
* description: Creates a new notification service for a user. Users can only create services for themselves. * description: Creates a new notification service for a user. Users can only create services for themselves.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/notification-services/{id}: * /notification-services/{id}:
* delete: * delete:
* summary: Delete notification service * summary: Delete notification service
* description: Deletes a notification service. Users can delete their own services, project managers can delete board services. * description: Deletes a notification service. Users can delete their own services, project managers can delete board services.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/notification-services/{id}/test: * /notification-services/{id}/test:
* post: * post:
* summary: Test notification service * summary: Test notification service
* description: Sends a test notification to verify the notification service is working. Users can test their own services, project managers can test board services. * description: Sends a test notification to verify the notification service is working. Users can test their own services, project managers can test board services.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/notification-services/{id}: * /notification-services/{id}:
* patch: * patch:
* summary: Update notification service * summary: Update notification service
* description: Updates a notification service. Users can update their own services, project managers can update board services. * description: Updates a notification service. Users can update their own services, project managers can update board services.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/notifications: * /notifications:
* get: * get:
* summary: Get user notifications * summary: Get user notifications
* description: Retrieves all unread notifications for the current user, including creator users. * description: Retrieves all unread notifications for the current user, including creator users.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/notifications/read-all: * /notifications/read-all:
* post: * post:
* summary: Mark all notifications as read * summary: Mark all notifications as read
* description: Marks all notifications for the current user as read. * description: Marks all notifications for the current user as read.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/notifications/{id}: * /notifications/{id}:
* get: * get:
* summary: Get notification details * summary: Get notification details
* description: Retrieves notification, including creator users. Users can only access their own notifications. * description: Retrieves notification, including creator users. Users can only access their own notifications.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/notifications/{id}: * /notifications/{id}:
* patch: * patch:
* summary: Update notification * summary: Update notification
* description: Updates a notification. Users can only update their own notifications. * description: Updates a notification. Users can only update their own notifications.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects/{projectId}/managers: * /projects/{projectId}/managers:
* post: * post:
* summary: Add project manager * summary: Add project manager
* description: Adds a user as a project manager. Requires admin privileges for shared projects or existing project manager permissions. The user must be an admin or project owner. * description: Adds a user as a project manager. Requires admin privileges for shared projects or existing project manager permissions. The user must be an admin or project owner.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/project-managers/{id}: * /project-managers/{id}:
* delete: * delete:
* summary: Remove project manager * summary: Remove project manager
* description: Removes a user from project managers. Requires admin privileges for shared projects or existing project manager permissions. Cannot remove the last project manager. * description: Removes a user from project managers. Requires admin privileges for shared projects or existing project manager permissions. Cannot remove the last project manager.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects: * /projects:
* post: * post:
* summary: Create project * summary: Create project
* description: Creates a project. The current user automatically becomes a project manager. * description: Creates a project. The current user automatically becomes a project manager.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects/{id}: * /projects/{id}:
* delete: * delete:
* summary: Delete project * summary: Delete project
* description: Deletes a project. The project must not have any boards. Requires project manager permissions. * description: Deletes a project. The project must not have any boards. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects: * /projects:
* get: * get:
* summary: Get all accessible projects * summary: Get all accessible projects
* description: Retrieves all projects the current user has access to, including managed projects, membership projects, and shared projects (for admins). * description: Retrieves all projects the current user has access to, including managed projects, membership projects, and shared projects (for admins).

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects/{id}: * /projects/{id}:
* get: * get:
* summary: Get project details * summary: Get project details
* description: Retrieves comprehensive project information, including boards, board memberships, and other related data. * description: Retrieves comprehensive project information, including boards, board memberships, and other related data.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/projects/{id}: * /projects/{id}:
* patch: * patch:
* summary: Update project * summary: Update project
* description: Updates a project. Accessible fields depend on user permissions. * description: Updates a project. Accessible fields depend on user permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/cards/{cardId}/task-lists: * /cards/{cardId}/task-lists:
* post: * post:
* summary: Create task list * summary: Create task list
* description: Creates a task list within a card. Requires board editor permissions. * description: Creates a task list within a card. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/task-lists/{id}: * /task-lists/{id}:
* delete: * delete:
* summary: Delete task list * summary: Delete task list
* description: Deletes a task list and all its tasks. Requires board editor permissions. * description: Deletes a task list and all its tasks. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/task-lists/{id}: * /task-lists/{id}:
* get: * get:
* summary: Get task list details * summary: Get task list details
* description: Retrieves task list information, including tasks. Requires access to the card. * description: Retrieves task list information, including tasks. Requires access to the card.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/task-lists/{id}: * /task-lists/{id}:
* patch: * patch:
* summary: Update task list * summary: Update task list
* description: Updates a task list. Requires board editor permissions. * description: Updates a task list. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/task-lists/{taskListId}/tasks: * /task-lists/{taskListId}/tasks:
* post: * post:
* summary: Create task * summary: Create task
* description: Creates a task within a task list. Either `linkedCardId` or `name` must be provided. Requires board editor permissions. * description: Creates a task within a task list. Either `linkedCardId` or `name` must be provided. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/tasks/{id}: * /tasks/{id}:
* delete: * delete:
* summary: Delete task * summary: Delete task
* description: Deletes a task. Requires board editor permissions. * description: Deletes a task. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/tasks/{id}: * /tasks/{id}:
* patch: * patch:
* summary: Update task * summary: Update task
* description: Updates a task. Linked card tasks have limited update options. Requires board editor permissions. * description: Updates a task. Linked card tasks have limited update options. Requires board editor permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/terms: * /terms:
* get: * get:
* summary: Get terms and conditions * summary: Get terms and conditions
* description: Retrieves terms and conditions in the specified language. * description: Retrieves terms and conditions in the specified language.

View File

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

View File

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

View File

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

View File

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

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/users/{id}/avatar: * /users/{id}/avatar:
* patch: * patch:
* summary: Update user avatar * summary: Update user avatar
* description: Updates a user's avatar image. Users can update their own avatar, admins can update any user's 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 * @swagger
* /api/users/{id}/email: * /users/{id}/email:
* patch: * patch:
* summary: Update user email * 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. * 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 * @swagger
* /api/users/{id}/password: * /users/{id}/password:
* patch: * patch:
* summary: Update user password * 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. * 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 * @swagger
* /api/users/{id}/username: * /users/{id}/username:
* patch: * patch:
* summary: Update user username * 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. * 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 * @swagger
* /api/users/{id}: * /users/{id}:
* patch: * patch:
* summary: Update user * summary: Update user
* description: Updates a user. Users can update their own profile, admins can update any user. * description: Updates a user. Users can update their own profile, admins can update any user.

View File

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

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/webhooks/{id}: * /webhooks/{id}:
* delete: * delete:
* summary: Delete webhook * summary: Delete webhook
* description: Deletes a webhook. Requires admin privileges. * description: Deletes a webhook. Requires admin privileges.

View File

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

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /api/webhooks/{id}: * /webhooks/{id}:
* patch: * patch:
* summary: Update webhook * summary: Update webhook
* description: Updates a webhook. Requires admin privileges. * description: Updates a webhook. Requires admin privileges.

View File

@@ -18,6 +18,12 @@ module.exports = {
url: 'https://github.com/plankanban/planka/blob/master/LICENSE.md', url: 'https://github.com/plankanban/planka/blob/master/LICENSE.md',
}, },
}, },
servers: [
{
url: '/api',
description: 'Base path for API endpoints',
},
],
}, },
apis: ['./api/controllers/**/*.js', './api/models/*.js', './api/responses/*.js'], apis: ['./api/controllers/**/*.js', './api/models/*.js', './api/responses/*.js'],
}; };