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

13
server/api/models/Webhook.js
View File

@@ -20,6 +20,11 @@
* - id
* - name
* - url
* - accessToken
* - events
* - excludedEvents
* - createdAt
* - updatedAt
* properties:
* id:
* type: string
@@ -40,24 +45,28 @@
* example: secret_token_123
* events:
* type: array
* nullable: true
* description: List of events that trigger the webhook
* items:
* type: string
* description: List of events that trigger the webhook
* example: [cardCreate, cardUpdate, cardDelete]
* excludedEvents:
* type: array
* nullable: true
* description: List of events excluded from the webhook
* items:
* type: string
* description: List of events excluded from the webhook
* example: [userCreate, userUpdate, userDelete]
* createdAt:
* type: string
* format: date-time
* nullable: true
* description: When the webhook was created
* example: 2024-01-01T00:00:00.000Z
* updatedAt:
* type: string
* format: date-time
* nullable: true
* description: When the webhook was last updated
* example: 2024-01-01T00:00:00.000Z
*/