docs: Correct invalid/missing details in Swagger

This commit is contained in:
Maksim Eltyshev
2025-09-16 15:51:14 +02:00
parent 33eef6e068
commit 97ddefc236
12 changed files with 28 additions and 24 deletions

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /access-tokens: * /access-tokens/me:
* 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
* /boards/{boardId}/memberships: * /boards/{boardId}/board-memberships:
* post: * post:
* summary: Create board membership * summary: Create board membership
* description: Creates a board membership within a board. Requires project manager permissions. * description: Creates a board membership within a board. Requires project manager permissions.

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /cards/{cardId}/labels: * /cards/{cardId}/card-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
* /cards/{cardId}/labels/{labelId}: * /cards/{cardId}/card-labels/labelId:{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
* /cards/{cardId}/memberships: * /cards/{cardId}/card-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
* /cards/{cardId}/memberships/{userId}: * /cards/{cardId}/card-memberships/userId:{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,8 +5,8 @@
/** /**
* @swagger * @swagger
* /cards/{cardId}/custom-field-values: * /cards/{cardId}/custom-field-values/customFieldGroupId:{customFieldGroupId}:customFieldId:${customFieldId}:
* post: * patch:
* 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.
* tags: * tags:
@@ -20,6 +20,20 @@
* schema: * schema:
* type: string * type: string
* example: "1357158568008091264" * example: "1357158568008091264"
* - name: customFieldGroupId
* in: path
* required: true
* description: ID of the custom field group the value belongs to
* schema:
* type: string
* example: "1357158568008091265"
* - name: customFieldId
* in: path
* required: true
* description: ID of the custom field the value belongs to
* schema:
* type: string
* example: "1357158568008091266"
* requestBody: * requestBody:
* required: true * required: true
* content: * content:
@@ -27,18 +41,8 @@
* schema: * schema:
* type: object * type: object
* required: * required:
* - customFieldGroupId
* - customFieldId
* - content * - content
* properties: * properties:
* customFieldGroupId:
* type: string
* description: ID of the custom field group the value belongs to
* example: "1357158568008091265"
* customFieldId:
* type: string
* description: ID of the custom field the value belongs to
* example: "1357158568008091266"
* content: * content:
* type: string * type: string
* maxLength: 512 * maxLength: 512

View File

@@ -5,7 +5,7 @@
/** /**
* @swagger * @swagger
* /cards/{cardId}/custom-field-groups/{customFieldGroupId}/custom-fields/{customFieldId}/value: * /cards/{cardId}/custom-field-value/customFieldGroupId:{customFieldGroupId}:customFieldId:${customFieldId}:
* 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
* /projects/{projectId}/managers: * /projects/{projectId}/project-managers:
* post: * post:
* summary: Create project manager * summary: Create project manager
* description: Creates a project manager within a project. Requires admin privileges for shared projects or existing project manager permissions. The user must be an admin or project owner. * description: Creates a project manager within a project. 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
* /terms: * /terms/{type}:
* 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.
@@ -14,7 +14,7 @@
* operationId: getTerms * operationId: getTerms
* parameters: * parameters:
* - name: type * - name: type
* in: query * in: path
* required: true * required: true
* description: Type of terms to retrieve * description: Type of terms to retrieve
* schema: * schema:

View File

@@ -6,7 +6,7 @@
/** /**
* @swagger * @swagger
* /users/{id}/avatar: * /users/{id}/avatar:
* patch: * post:
* 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.
* tags: * tags:

View File

@@ -12,7 +12,7 @@ module.exports = {
version, version,
title: 'PLANKA API', title: 'PLANKA API',
description: description:
'API documentation for PLANKA - Real-time Collaborative Kanban Board Application', 'API documentation for PLANKA - Real-Time Collaborative Kanban Board Application',
license: { license: {
name: 'Fair Use License', name: 'Fair Use License',
url: 'https://github.com/plankanban/planka/blob/master/LICENSE.md', url: 'https://github.com/plankanban/planka/blob/master/LICENSE.md',