starred/planka
1
0
Fork 0
mirror of https://github.com/plankanban/planka.git synced 2025-12-19 17:23:27 +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

35
server/api/controllers/attachments/create.js
View File

@@ -11,6 +11,7 @@
* description: Creates an attachment on a card. Requires board editor permissions.
* tags:
* - Attachments
* operationId: createAttachment
* parameters:
* - name: cardId
* in: path
@@ -22,21 +23,25 @@
* requestBody:
* required: true
* content:
* application/json:
* multipart/form-data:
* schema:
* type: object
* required:
* - type
* - url
* - name
* properties:
* type:
* type: string
* enum: [link]
* enum: [file, link]
* description: Type of the attachment
* example: link
* file:
* type: string
* format: binary
* description: File to upload
* url:
* type: string
* format: url
* maxLength: 2048
* description: URL for the link attachment
* example: https://google.com/search?q=planka
@@ -44,29 +49,7 @@
* type: string
* maxLength: 128
* description: Name/title of the attachment
* example: Google Link
* multipart/form-data:
* schema:
* type: object
* required:
* - type
* - file
* - name
* properties:
* type:
* type: string
* enum: [file]
* description: Type of the attachment
* example: file
* file:
* type: string
* format: binary
* description: File to upload
* name:
* type: string
* maxLength: 128
* description: Name/title of the attachment
* example: Important Document
* example: Important Attachment
* requestId:
* type: string
* maxLength: 128