diff --git a/server/api/controllers/notification-services/create-in-board.js b/server/api/controllers/notification-services/create-in-board.js index 1db0f707..1c9f0227 100644 --- a/server/api/controllers/notification-services/create-in-board.js +++ b/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] diff --git a/server/api/controllers/notification-services/create-in-user.js b/server/api/controllers/notification-services/create-in-user.js index b4546886..d8165ecf 100644 --- a/server/api/controllers/notification-services/create-in-user.js +++ b/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] diff --git a/server/api/controllers/notification-services/update.js b/server/api/controllers/notification-services/update.js index 129b4ba9..1f0f5849 100644 --- a/server/api/controllers/notification-services/update.js +++ b/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] diff --git a/server/api/controllers/webhooks/create.js b/server/api/controllers/webhooks/create.js index 67eb5808..18476754 100644 --- a/server/api/controllers/webhooks/create.js +++ b/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 diff --git a/server/api/controllers/webhooks/update.js b/server/api/controllers/webhooks/update.js index 4748fdae..81be8b0b 100644 --- a/server/api/controllers/webhooks/update.js +++ b/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 diff --git a/server/api/models/Action.js b/server/api/models/Action.js index 71e44d9f..aa1450ba 100755 --- a/server/api/models/Action.js +++ b/server/api/models/Action.js @@ -17,6 +17,7 @@ * Action: * type: object * required: + * - id * - cardId * - type * - data diff --git a/server/api/models/Attachment.js b/server/api/models/Attachment.js index bbc9b37d..c0512c63 100644 --- a/server/api/models/Attachment.js +++ b/server/api/models/Attachment.js @@ -17,6 +17,7 @@ * Attachment: * type: object * required: + * - id * - cardId * - type * - data diff --git a/server/api/models/BackgroundImage.js b/server/api/models/BackgroundImage.js index dd0cf0f8..84a51d2c 100644 --- a/server/api/models/BackgroundImage.js +++ b/server/api/models/BackgroundImage.js @@ -17,6 +17,7 @@ * BackgroundImage: * type: object * required: + * - id * - projectId * - size * - url diff --git a/server/api/models/BaseCustomFieldGroup.js b/server/api/models/BaseCustomFieldGroup.js index e134826b..c75c248d 100755 --- a/server/api/models/BaseCustomFieldGroup.js +++ b/server/api/models/BaseCustomFieldGroup.js @@ -17,6 +17,7 @@ * BaseCustomFieldGroup: * type: object * required: + * - id * - projectId * - name * properties: diff --git a/server/api/models/Board.js b/server/api/models/Board.js index 3aea0276..ed1502de 100755 --- a/server/api/models/Board.js +++ b/server/api/models/Board.js @@ -17,6 +17,7 @@ * Board: * type: object * required: + * - id * - projectId * - position * - name diff --git a/server/api/models/BoardMembership.js b/server/api/models/BoardMembership.js index 2c6612bc..7c029fe3 100644 --- a/server/api/models/BoardMembership.js +++ b/server/api/models/BoardMembership.js @@ -17,10 +17,11 @@ * BoardMembership: * type: object * required: - * - role + * - id * - projectId * - boardId * - userId + * - role * properties: * id: * type: string diff --git a/server/api/models/Card.js b/server/api/models/Card.js index 8304982d..5ef0fee9 100755 --- a/server/api/models/Card.js +++ b/server/api/models/Card.js @@ -17,6 +17,7 @@ * Card: * type: object * required: + * - id * - boardId * - listId * - type diff --git a/server/api/models/CardLabel.js b/server/api/models/CardLabel.js index 0dcf20dd..52162794 100755 --- a/server/api/models/CardLabel.js +++ b/server/api/models/CardLabel.js @@ -17,6 +17,7 @@ * CardLabel: * type: object * required: + * - id * - cardId * - labelId * properties: diff --git a/server/api/models/CardMembership.js b/server/api/models/CardMembership.js index eabf3cdb..bd9bb54e 100755 --- a/server/api/models/CardMembership.js +++ b/server/api/models/CardMembership.js @@ -17,6 +17,7 @@ * CardMembership: * type: object * required: + * - id * - cardId * - userId * properties: diff --git a/server/api/models/Comment.js b/server/api/models/Comment.js index 72faf83b..c9ea7bf8 100644 --- a/server/api/models/Comment.js +++ b/server/api/models/Comment.js @@ -17,6 +17,7 @@ * Comment: * type: object * required: + * - id * - cardId * - text * properties: diff --git a/server/api/models/Config.js b/server/api/models/Config.js index 86b26eca..669fd4b4 100644 --- a/server/api/models/Config.js +++ b/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: - * type: string - * format: date-time + * oidc: + * type: object + * required: + * - authorizationUrl + * - endSessionUrl + * - isEnforced * nullable: true - * description: When the config was created - * example: 2024-01-01T00:00:00.000Z - * updatedAt: - * type: string - * format: date-time - * nullable: true - * description: When the config was last updated - * example: 2024-01-01T00:00:00.000Z + * description: OpenID Connect configuration (null if not configured) + * properties: + * authorizationUrl: + * type: string + * format: uri + * description: OIDC authorization URL for initiating authentication + * example: https://oidc.example.com/auth + * 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'; diff --git a/server/api/models/CustomField.js b/server/api/models/CustomField.js index 08e513c6..56f3c910 100755 --- a/server/api/models/CustomField.js +++ b/server/api/models/CustomField.js @@ -17,6 +17,7 @@ * CustomField: * type: object * required: + * - id * - position * - name * - showOnFrontOfCard diff --git a/server/api/models/CustomFieldGroup.js b/server/api/models/CustomFieldGroup.js index fb0cdc83..491ba46e 100755 --- a/server/api/models/CustomFieldGroup.js +++ b/server/api/models/CustomFieldGroup.js @@ -17,6 +17,7 @@ * CustomFieldGroup: * type: object * required: + * - id * - position * properties: * id: diff --git a/server/api/models/CustomFieldValue.js b/server/api/models/CustomFieldValue.js index 4c2d1735..f190b91c 100644 --- a/server/api/models/CustomFieldValue.js +++ b/server/api/models/CustomFieldValue.js @@ -17,6 +17,7 @@ * CustomFieldValue: * type: object * required: + * - id * - cardId * - customFieldGroupId * - customFieldId diff --git a/server/api/models/Label.js b/server/api/models/Label.js index 82db0cf6..13e89106 100755 --- a/server/api/models/Label.js +++ b/server/api/models/Label.js @@ -17,6 +17,7 @@ * Label: * type: object * required: + * - id * - boardId * - position * - color diff --git a/server/api/models/List.js b/server/api/models/List.js index 9c6580ec..32225324 100755 --- a/server/api/models/List.js +++ b/server/api/models/List.js @@ -17,6 +17,7 @@ * List: * type: object * required: + * - id * - boardId * - type * properties: diff --git a/server/api/models/NotificationService.js b/server/api/models/NotificationService.js index 8bb8fa6c..1313364b 100644 --- a/server/api/models/NotificationService.js +++ b/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] diff --git a/server/api/models/Project.js b/server/api/models/Project.js index 1b2118e7..a3345017 100755 --- a/server/api/models/Project.js +++ b/server/api/models/Project.js @@ -17,6 +17,7 @@ * Project: * type: object * required: + * - id * - name * properties: * id: diff --git a/server/api/models/ProjectManager.js b/server/api/models/ProjectManager.js index f66cbc15..5151f667 100644 --- a/server/api/models/ProjectManager.js +++ b/server/api/models/ProjectManager.js @@ -17,6 +17,7 @@ * ProjectManager: * type: object * required: + * - id * - projectId * - userId * properties: diff --git a/server/api/models/Task.js b/server/api/models/Task.js index 879aae83..4d171ec5 100755 --- a/server/api/models/Task.js +++ b/server/api/models/Task.js @@ -17,6 +17,7 @@ * Task: * type: object * required: + * - id * - taskListId * - position * - name diff --git a/server/api/models/TaskList.js b/server/api/models/TaskList.js index 5e9d8ac1..5d27f92b 100644 --- a/server/api/models/TaskList.js +++ b/server/api/models/TaskList.js @@ -17,6 +17,7 @@ * TaskList: * type: object * required: + * - id * - cardId * - position * - name diff --git a/server/api/models/Webhook.js b/server/api/models/Webhook.js index 0affe11a..023f15a6 100644 --- a/server/api/models/Webhook.js +++ b/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