chore: Add Swagger config

This commit is contained in:
Maksim Eltyshev
2025-09-08 17:41:43 +02:00
parent 7fea8f5362
commit 4910600e6c
2 changed files with 25 additions and 2 deletions

View File

@@ -53,12 +53,12 @@
* type: string
* format: date-time
* description: When the webhook was created
* example: 2024-03-01T12:00:00.000Z
* example: 2024-01-01T00:00:00.000Z
* updatedAt:
* type: string
* format: date-time
* description: When the webhook was last updated
* example: 2024-03-02T15:30:00.000Z
* example: 2024-01-01T00:00:00.000Z
*/
const Events = {

23
server/config/swagger.js Normal file
View File

@@ -0,0 +1,23 @@
/*!
* Copyright (c) 2024 PLANKA Software GmbH
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
const version = require('../version');
module.exports = {
definition: {
openapi: '3.0.0',
info: {
version,
title: 'PLANKA API',
description:
'API documentation for PLANKA - Real-time Collaborative Kanban Board Application',
license: {
name: 'Fair Use License',
url: 'https://github.com/plankanban/planka/blob/master/LICENSE.md',
},
},
},
apis: ['./api/controllers/**/*.js', './api/models/*.js', './api/responses/*.js'],
};