mirror of
https://github.com/plankanban/planka.git
synced 2025-12-19 17:23:27 +03:00
docs: Add full Swagger JSDoc coverage
This commit is contained in:
@@ -3,6 +3,78 @@
|
||||
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /api/webhooks/{id}:
|
||||
* patch:
|
||||
* summary: Update webhook
|
||||
* description: Updates a webhook. Requires admin privileges.
|
||||
* tags:
|
||||
* - Webhooks
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* required: true
|
||||
* description: ID of the webhook to update
|
||||
* schema:
|
||||
* type: string
|
||||
* example: 1357158568008091264
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* maxLength: 128
|
||||
* description: Name/title of the webhook
|
||||
* example: Webhook Updates
|
||||
* url:
|
||||
* type: string
|
||||
* format: url
|
||||
* maxLength: 2048
|
||||
* description: URL endpoint for the webhook
|
||||
* example: https://example.service.com/planka
|
||||
* accessToken:
|
||||
* type: string
|
||||
* maxLength: 512
|
||||
* nullable: true
|
||||
* description: Access token for webhook authentication
|
||||
* example: secret_token_123
|
||||
* events:
|
||||
* type: string
|
||||
* maxLength: 2048
|
||||
* nullable: true
|
||||
* description: Comma-separated list of events that trigger the webhook
|
||||
* example: cardCreate,cardUpdate,cardDelete
|
||||
* excludedEvents:
|
||||
* type: string
|
||||
* maxLength: 2048
|
||||
* nullable: true
|
||||
* description: Comma-separated list of events excluded from the webhook
|
||||
* example: userCreate,userUpdate,userDelete
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Webhook updated successfully
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - item
|
||||
* properties:
|
||||
* item:
|
||||
* $ref: '#/components/schemas/Webhook'
|
||||
* 400:
|
||||
* $ref: '#/components/responses/ValidationError'
|
||||
* 401:
|
||||
* $ref: '#/components/responses/Unauthorized'
|
||||
* 404:
|
||||
* $ref: '#/components/responses/NotFound'
|
||||
*/
|
||||
|
||||
const { isUrl } = require('../../../utils/validators');
|
||||
const { idInput } = require('../../../utils/inputs');
|
||||
|
||||
|
||||
Reference in New Issue
Block a user