mirror of
https://github.com/plankanban/planka.git
synced 2025-12-20 01:14:12 +03:00
docs: Add full Swagger JSDoc coverage
This commit is contained in:
@@ -10,6 +10,53 @@
|
||||
* @docs :: https://sailsjs.com/docs/concepts/models-and-orm/models
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* components:
|
||||
* schemas:
|
||||
* NotificationService:
|
||||
* type: object
|
||||
* required:
|
||||
* - url
|
||||
* - format
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* description: Unique identifier for the notification service
|
||||
* example: 1357158568008091264
|
||||
* userId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the user the service is associated with
|
||||
* example: 1357158568008091265
|
||||
* boardId:
|
||||
* type: string
|
||||
* nullable: true
|
||||
* description: ID of the board the service is associated with
|
||||
* example: 1357158568008091266
|
||||
* url:
|
||||
* type: string
|
||||
* description: URL endpoint for notifications
|
||||
* example: https://example.service.com/planka
|
||||
* format:
|
||||
* type: string
|
||||
* enum: [text, markdown, html]
|
||||
* description: Format for notification messages
|
||||
* example: text
|
||||
* createdAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* description: When the notification service was created
|
||||
* example: 2024-01-01T00:00:00.000Z
|
||||
* updatedAt:
|
||||
* type: string
|
||||
* format: date-time
|
||||
* nullable: true
|
||||
* description: When the notification service was last updated
|
||||
* example: 2024-01-01T00:00:00.000Z
|
||||
*/
|
||||
|
||||
const Formats = {
|
||||
TEXT: 'text',
|
||||
MARKDOWN: 'markdown',
|
||||
|
||||
Reference in New Issue
Block a user