docs: Add full Swagger JSDoc coverage

This commit is contained in:
Maksim Eltyshev
2025-09-08 16:20:27 +02:00
parent e6b4c33542
commit 5ad3134519
128 changed files with 7610 additions and 0 deletions

View File

@@ -3,6 +3,53 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /api/notifications/{id}:
* get:
* summary: Get notification details
* description: Retrieves notification, including creator users. Users can only access their own notifications.
* tags:
* - Notifications
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the notification to retrieve
* schema:
* type: string
* example: 1357158568008091264
* responses:
* 200:
* description: Notification details retrieved successfully
* content:
* application/json:
* schema:
* type: object
* required:
* - item
* - included
* properties:
* item:
* $ref: '#/components/schemas/Notification'
* included:
* type: object
* required:
* - users
* properties:
* users:
* type: array
* description: Related users
* items:
* $ref: '#/components/schemas/User'
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 404:
* $ref: '#/components/responses/NotFound'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {