docs: Add missing details to Swagger

server/api/controllers/notification-services/create-in-board.js

@@ -33,7 +33,7 @@
  *                 type: string
  *                 maxLength: 512
  *                 description: URL endpoint for notifications
- *                 example: https://example.service.com/planka
+ *                 example: https://service.example.com/planka
  *               format:
  *                 type: string
  *                 enum: [text, markdown, html]

server/api/controllers/notification-services/create-in-user.js

@@ -33,7 +33,7 @@
  *                 type: string
  *                 maxLength: 512
  *                 description: URL endpoint for notifications
- *                 example: https://example.service.com/planka
+ *                 example: https://service.example.com/planka
  *               format:
  *                 type: string
  *                 enum: [text, markdown, html]

server/api/controllers/notification-services/update.js

@@ -30,7 +30,7 @@
  *                 type: string
  *                 maxLength: 512
  *                 description: URL endpoint for notifications
- *                 example: https://example.service.com/planka
+ *                 example: https://service.example.com/planka
  *               format:
  *                 type: string
  *                 enum: [text, markdown, html]

server/api/controllers/webhooks/create.js

@@ -31,7 +31,7 @@
  *                 format: url
  *                 maxLength: 2048
  *                 description: URL endpoint for the webhook
- *                 example: https://example.service.com/planka
+ *                 example: https://service.example.com/planka
  *               accessToken:
  *                 type: string
  *                 maxLength: 512

server/api/controllers/webhooks/update.js

@@ -36,7 +36,7 @@
  *                 format: url
  *                 maxLength: 2048
  *                 description: URL endpoint for the webhook
- *                 example: https://example.service.com/planka
+ *                 example: https://service.example.com/planka
  *               accessToken:
  *                 type: string
  *                 maxLength: 512

server/api/models/Action.js

@@ -17,6 +17,7 @@
  *     Action:
  *       type: object
  *       required:
+ *         - id
  *         - cardId
  *         - type
  *         - data

server/api/models/Attachment.js

@@ -17,6 +17,7 @@
  *     Attachment:
  *       type: object
  *       required:
+ *         - id
  *         - cardId
  *         - type
  *         - data

server/api/models/BackgroundImage.js

@@ -17,6 +17,7 @@
  *     BackgroundImage:
  *       type: object
  *       required:
+ *         - id
  *         - projectId
  *         - size
  *         - url

server/api/models/BaseCustomFieldGroup.js

@@ -17,6 +17,7 @@
  *     BaseCustomFieldGroup:
  *       type: object
  *       required:
+ *         - id
  *         - projectId
  *         - name
  *       properties:

server/api/models/Board.js

@@ -17,6 +17,7 @@
  *     Board:
  *       type: object
  *       required:
+ *         - id
  *         - projectId
  *         - position
  *         - name

server/api/models/BoardMembership.js

@@ -17,10 +17,11 @@
  *     BoardMembership:
  *       type: object
  *       required:
- *         - role
+ *         - id
  *         - projectId
  *         - boardId
  *         - userId
+ *         - role
  *       properties:
  *         id:
  *           type: string

server/api/models/Card.js

@@ -17,6 +17,7 @@
  *     Card:
  *       type: object
  *       required:
+ *         - id
  *         - boardId
  *         - listId
  *         - type

server/api/models/CardLabel.js

@@ -17,6 +17,7 @@
  *     CardLabel:
  *       type: object
  *       required:
+ *         - id
  *         - cardId
  *         - labelId
  *       properties:

server/api/models/CardMembership.js

@@ -17,6 +17,7 @@
  *     CardMembership:
  *       type: object
  *       required:
+ *         - id
  *         - cardId
  *         - userId
  *       properties:

server/api/models/Comment.js

@@ -17,6 +17,7 @@
  *     Comment:
  *       type: object
  *       required:
+ *         - id
  *         - cardId
  *         - text
  *       properties:

server/api/models/Config.js

@@ -17,18 +17,8 @@
  *     Config:
  *       type: object
  *       required:
- *         - id
- *         - isInitialized
  *         - version
  *       properties:
- *         id:
- *           type: string
- *           description: Unique identifier for the config (always set to '1')
- *           example: 1
- *         isInitialized:
- *           type: boolean
- *           description: Whether the PLANKA instance has been initialized
- *           example: true
  *         version:
  *           type: string
  *           description: Current version of the PLANKA application
@@ -38,18 +28,30 @@
  *           nullable: true
  *           description: Maximum number of active users allowed (conditionally added for admins if configured)
  *           example: 100
- *         createdAt:
+ *         oidc:
- *           type: string
+ *           type: object
- *           format: date-time
+ *           required:
+ *             - authorizationUrl
+ *             - endSessionUrl
+ *             - isEnforced
  *           nullable: true
- *           description: When the config was created
+ *           description: OpenID Connect configuration (null if not configured)
- *           example: 2024-01-01T00:00:00.000Z
+ *           properties:
- *         updatedAt:
+ *             authorizationUrl:
- *           type: string
+ *               type: string
- *           format: date-time
+ *               format: uri
- *           nullable: true
+ *               description: OIDC authorization URL for initiating authentication
- *           description: When the config was last updated
+ *               example: https://oidc.example.com/auth
- *           example: 2024-01-01T00:00:00.000Z
+ *             endSessionUrl:
+ *               type: string
+ *               format: uri
+ *               nullable: true
+ *               description: OIDC end session URL for logout (null if not supported by provider)
+ *               example: https://oidc.example.com/logout
+ *             isEnforced:
+ *               type: boolean
+ *               description: Whether OIDC authentication is enforced (users must use OIDC to login)
+ *               example: false
  */
 
 const MAIN_ID = '1';

server/api/models/CustomField.js

@@ -17,6 +17,7 @@
  *     CustomField:
  *       type: object
  *       required:
+ *         - id
  *         - position
  *         - name
  *         - showOnFrontOfCard

server/api/models/CustomFieldGroup.js

@@ -17,6 +17,7 @@
  *     CustomFieldGroup:
  *       type: object
  *       required:
+ *         - id
  *         - position
  *       properties:
  *         id:

server/api/models/CustomFieldValue.js

@@ -17,6 +17,7 @@
  *     CustomFieldValue:
  *       type: object
  *       required:
+ *         - id
  *         - cardId
  *         - customFieldGroupId
  *         - customFieldId

server/api/models/Label.js

@@ -17,6 +17,7 @@
  *     Label:
  *       type: object
  *       required:
+ *         - id
  *         - boardId
  *         - position
  *         - color

server/api/models/List.js

@@ -17,6 +17,7 @@
  *     List:
  *       type: object
  *       required:
+ *         - id
  *         - boardId
  *         - type
  *       properties:

server/api/models/NotificationService.js

@@ -17,6 +17,7 @@
  *     NotificationService:
  *       type: object
  *       required:
+ *         - id
  *         - url
  *         - format
  *       properties:
@@ -37,7 +38,7 @@
  *         url:
  *           type: string
  *           description: URL endpoint for notifications
- *           example: https://example.service.com/planka
+ *           example: https://service.example.com/planka
  *         format:
  *           type: string
  *           enum: [text, markdown, html]

server/api/models/Project.js

@@ -17,6 +17,7 @@
  *     Project:
  *       type: object
  *       required:
+ *         - id
  *         - name
  *       properties:
  *         id:

server/api/models/ProjectManager.js

@@ -17,6 +17,7 @@
  *     ProjectManager:
  *       type: object
  *       required:
+ *         - id
  *         - projectId
  *         - userId
  *       properties:

server/api/models/Task.js

@@ -17,6 +17,7 @@
  *     Task:
  *       type: object
  *       required:
+ *         - id
  *         - taskListId
  *         - position
  *         - name

server/api/models/TaskList.js

@@ -17,6 +17,7 @@
  *     TaskList:
  *       type: object
  *       required:
+ *         - id
  *         - cardId
  *         - position
  *         - name

server/api/models/Webhook.js

@@ -17,6 +17,7 @@
  *     Webhook:
  *       type: object
  *       required:
+ *         - id
  *         - name
  *         - url
  *       properties:
@@ -31,7 +32,7 @@
  *         url:
  *           type: string
  *           description: URL endpoint for the webhook
- *           example: https://example.service.com/planka
+ *           example: https://webhook.example.com/planka
  *         accessToken:
  *           type: string
  *           nullable: true