mirror of
https://github.com/plankanban/planka.git
synced 2025-12-21 09:15:51 +03:00
docs: Add base path for API endpoints to Swagger
This commit is contained in:
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/boards/{boardId}/custom-field-groups:
|
||||
* /boards/{boardId}/custom-field-groups:
|
||||
* post:
|
||||
* 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.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/cards/{cardId}/custom-field-groups:
|
||||
* /cards/{cardId}/custom-field-groups:
|
||||
* post:
|
||||
* 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.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/custom-field-groups/{id}:
|
||||
* /custom-field-groups/{id}:
|
||||
* delete:
|
||||
* summary: Delete custom field group
|
||||
* description: Deletes a custom field group. Requires board editor permissions.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/custom-field-groups/{id}:
|
||||
* /custom-field-groups/{id}:
|
||||
* get:
|
||||
* summary: Get custom field group details
|
||||
* description: Retrieves comprehensive custom field group information, including fields and values. Requires access to the board/card.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/custom-field-groups/{id}:
|
||||
* /custom-field-groups/{id}:
|
||||
* patch:
|
||||
* summary: Update custom field group
|
||||
* description: Updates a custom field group. Supports both board-wide and card-specific groups. Requires board editor permissions.
|
||||
|
||||
Reference in New Issue
Block a user