mirror of
https://github.com/plankanban/planka.git
synced 2025-12-28 17:24:59 +03:00
docs: Add base path for API endpoints to Swagger
This commit is contained in:
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/projects:
|
||||
* /projects:
|
||||
* post:
|
||||
* summary: Create project
|
||||
* description: Creates a project. The current user automatically becomes a project manager.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/projects/{id}:
|
||||
* /projects/{id}:
|
||||
* delete:
|
||||
* summary: Delete project
|
||||
* description: Deletes a project. The project must not have any boards. Requires project manager permissions.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/projects:
|
||||
* /projects:
|
||||
* get:
|
||||
* 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).
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/projects/{id}:
|
||||
* /projects/{id}:
|
||||
* get:
|
||||
* summary: Get project details
|
||||
* description: Retrieves comprehensive project information, including boards, board memberships, and other related data.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/projects/{id}:
|
||||
* /projects/{id}:
|
||||
* patch:
|
||||
* summary: Update project
|
||||
* description: Updates a project. Accessible fields depend on user permissions.
|
||||
|
||||
Reference in New Issue
Block a user