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: Add missing details to Swagger

Browse Source
This commit is contained in:
Maksim Eltyshev
2025-09-08 23:40:36 +02:00
parent 9a81c83f03
commit dca4b65921
27 changed files with 52 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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]

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

@@ -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]

2
server/api/controllers/notification-services/update.js
View File

@@ -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]

2
server/api/controllers/webhooks/create.js
View File

@@ -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

2
server/api/controllers/webhooks/update.js
View File

@@ -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

1
server/api/models/Action.js
View File

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

1
server/api/models/Attachment.js
View File

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

1
server/api/models/BackgroundImage.js
View File

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

1
server/api/models/BaseCustomFieldGroup.js
View File

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

1
server/api/models/Board.js
View File

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

3
server/api/models/BoardMembership.js
View File

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

1
server/api/models/Card.js
View File

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

1
server/api/models/CardLabel.js
View File

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

1
server/api/models/CardMembership.js
View File

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

1
server/api/models/Comment.js
View File

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

44
server/api/models/Config.js
View File

@@ -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';

1
server/api/models/CustomField.js
View File

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

1
server/api/models/CustomFieldGroup.js
View File

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

1
server/api/models/CustomFieldValue.js
View File

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

1
server/api/models/Label.js
View File

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

1
server/api/models/List.js
View File

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

3
server/api/models/NotificationService.js
View File

@@ -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]

1
server/api/models/Project.js
View File

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

1
server/api/models/ProjectManager.js
View File

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

1
server/api/models/Task.js
View File

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

1
server/api/models/TaskList.js
View File

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

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

@@ -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