starred/planka
1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-12-26 09:15:01 +03:00
Code Issues 418 Packages Projects Releases 12 Wiki Activity

docs: Improve Swagger JSDoc

Browse Source
This commit is contained in:
Maksim Eltyshev
2025-09-12 12:17:01 +02:00
parent 494800d131
commit b4979d214f
129 changed files with 294 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
server/api/controllers/file-attachments/download-thumbnail.js
View File

@@ -3,62 +3,6 @@
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
/**
* @swagger
* /attachments/{id}/download/thumbnails/{fileName}.{fileExtension}:
* get:
* 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.
* tags:
* - File Attachments
* parameters:
* - name: id
* in: path
* required: true
* description: ID of the file attachment to download the thumbnail for
* schema:
* type: string
* example: "1357158568008091264"
* - name: fileName
* in: path
* required: true
* description: Thumbnail size identifier
* schema:
* type: string
* enum: [outside-360, outside-720]
* example: outside-360
* - name: fileExtension
* in: path
* required: true
* description: File extension of the thumbnail
* schema:
* type: string
* example: jpg
* responses:
* 200:
* description: Thumbnail image returned successfully
* content:
* image/*:
* schema:
* type: string
* format: binary
* headers:
* Content-Type:
* schema:
* type: string
* description: MIME type of the thumbnail image
* Cache-Control:
* schema:
* type: string
* description: Cache control header
* 400:
* $ref: '#/components/responses/ValidationError'
* 401:
* $ref: '#/components/responses/Unauthorized'
* 404:
* $ref: '#/components/responses/NotFound'
*/
const { idInput } = require('../../../utils/inputs');
const Errors = {