[PR #1486] WIP: Validate Swagger docs #1312

New Issue

OVERLORD · 2026-02-04T22:03:00+03:00

OVERLORD commented

2026-02-04 22:03:00 +03:00

📋 Pull Request Information

Original PR: https://github.com/plankanban/planka/pull/1486
Author: @hwelch-fle
Created: 1/18/2026
Status: 🔄 Open

Base: master ← Head: swagger-patches

📝 Commits (10+)

f69f288 match swagger project type enum to Project.Types
99abc7b add enum to User.termsType
8850cd1 update BackgroundImage size key (this should probably return an integer and not a string)
0034457 add coment clarifuying that position is required when updating listId and boardId
31c5abc chore: Minor perfectionist swap of project types in enum
9fcdd59 style g and j get cut off
b089b1a docs: Rename sizeInBytes back to size
1d5a737 currently webhooks throws a 404 if the user is not an admin.
181de27 docs: Ensure numbers used as strings are quoted
79bd6dd fix: Remove extra permission check handled in policy

📊 Changes

9 files changed (+10 additions, -8 deletions)

View changed files

📝 client/src/components/custom-fields/CustomField/CustomField.module.scss (+1 -0)
📝 server/api/controllers/cards/update.js (+1 -1)
📝 server/api/controllers/projects/create.js (+1 -1)
📝 server/api/controllers/terms/show.js (+1 -1)
📝 server/api/controllers/users/create.js (+1 -1)
📝 server/api/controllers/users/update.js (+1 -1)
📝 server/api/models/BackgroundImage.js (+1 -1)
📝 server/api/models/Config.js (+1 -1)
📝 server/api/models/User.js (+2 -1)

📄 Description

Since the new plankapy v2 interface is based on the generated swagger.json file, I need the docs match the API exactly.

This is going to be a large project, but I will continue to update this PR with small single line commits for each discrepancy I run into during implemetation and testing.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/plankanban/planka/pull/1486 **Author:** [@hwelch-fle](https://github.com/hwelch-fle) **Created:** 1/18/2026 **Status:** 🔄 Open **Base:** `master` ← **Head:** `swagger-patches` --- ### 📝 Commits (10+) - [`f69f288`](https://github.com/plankanban/planka/commit/f69f28804a07adde2bd064910585bf3bc620134e) match swagger project type enum to `Project.Types` - [`99abc7b`](https://github.com/plankanban/planka/commit/99abc7b442a5c20fda71781af81ed11b9f4ff7a7) add enum to `User.termsType` - [`8850cd1`](https://github.com/plankanban/planka/commit/8850cd18e66901d6a9fa58d4fe1f576d936481d2) update BackgroundImage size key (this should probably return an integer and not a string) - [`0034457`](https://github.com/plankanban/planka/commit/00344579a7012b67eb4e00805c0bb16343b49098) add coment clarifuying that `position` is required when updating `listId` and `boardId` - [`31c5abc`](https://github.com/plankanban/planka/commit/31c5abca0837e9fdae0b6f88fcb7913ec2576c18) chore: Minor perfectionist swap of project types in enum - [`9fcdd59`](https://github.com/plankanban/planka/commit/9fcdd598db33a4bd557e8a38a44c8b51d56f08dc) style `g` and `j` get cut off - [`b089b1a`](https://github.com/plankanban/planka/commit/b089b1aa0d6de99f2b8953c1e305dba8fc152243) docs: Rename `sizeInBytes` back to `size` - [`1d5a737`](https://github.com/plankanban/planka/commit/1d5a7379d89ed1299998b68beca81d6f74da7f56) currently `webhooks` throws a `404` if the user is not an admin. - [`181de27`](https://github.com/plankanban/planka/commit/181de27a9b6da39181231d70e2ffc505b2c51d8f) docs: Ensure numbers used as strings are quoted - [`79bd6dd`](https://github.com/plankanban/planka/commit/79bd6dd45b930a3405e1ba76a447c6b77eeaf64f) fix: Remove extra permission check handled in policy ### 📊 Changes **9 files changed** (+10 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `client/src/components/custom-fields/CustomField/CustomField.module.scss` (+1 -0) 📝 `server/api/controllers/cards/update.js` (+1 -1) 📝 `server/api/controllers/projects/create.js` (+1 -1) 📝 `server/api/controllers/terms/show.js` (+1 -1) 📝 `server/api/controllers/users/create.js` (+1 -1) 📝 `server/api/controllers/users/update.js` (+1 -1) 📝 `server/api/models/BackgroundImage.js` (+1 -1) 📝 `server/api/models/Config.js` (+1 -1) 📝 `server/api/models/User.js` (+2 -1) </details> ### 📄 Description Since the new plankapy v2 interface is based on the generated swagger.json file, I need the docs match the API exactly. This is going to be a large project, but I will continue to update this PR with small single line commits for each discrepancy I run into during implemetation and testing. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

OVERLORD added the pull-request label 2026-02-04 22:03:00 +03:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/planka#1312