starred/panel
1
0
Fork 0
mirror of https://github.com/pelican-dev/panel.git synced 2026-02-24 11:20:41 +03:00
Code Issues 42 Packages Projects Releases 12 Wiki Activity

[PR #1032] [MERGED] Small api docs improvements #1124

New Issue
Closed
opened 2026-02-04 19:19:28 +03:00 by OVERLORD · 0 comments
OVERLORD commented 2026-02-04 19:19:28 +03:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/pelican-dev/panel/pull/1032
Author: @Boy132
Created: 2/25/2025
Status: ✅ Merged
Merged: 2/26/2025
Merged by: @Boy132

Base: main ← Head: boy132/improve-api-docs

📝 Commits (10+)

  • 0d67a5b update scramble
  • fadca7c cleanup application api endpoints
  • e61e97c cleanup client api endpoints
  • 2499c14 fix security schema and make docs homepage nicer
  • 240ad1e Merge remote-tracking branch 'upstream/main' into boy132/improve-api-docs
  • 5d1a313 remove duplicate myclabs/deep-copy
  • 8281557 style(api-docs): use Blade template and Tailwind for styling
  • d10def6 Publish scramble view
  • 649d3f3 Use localStorage theme instead of config
  • 9482a9e Update routes/docs.php

📊 Changes

44 files changed (+436 additions, -29 deletions)

View changed files

📝 app/Http/Controllers/Api/Application/DatabaseHosts/DatabaseHostController.php (+10 -0)
📝 app/Http/Controllers/Api/Application/Eggs/EggController.php (+4 -0)
📝 app/Http/Controllers/Api/Application/Mounts/MountController.php (+18 -0)
📝 app/Http/Controllers/Api/Application/Nodes/AllocationController.php (+8 -0)
📝 app/Http/Controllers/Api/Application/Nodes/NodeConfigurationController.php (+4 -0)
📝 app/Http/Controllers/Api/Application/Nodes/NodeController.php (+12 -0)
📝 app/Http/Controllers/Api/Application/Nodes/NodeDeploymentController.php (+4 -0)
📝 app/Http/Controllers/Api/Application/Roles/RoleController.php (+10 -0)
📝 app/Http/Controllers/Api/Application/Servers/DatabaseController.php (+12 -0)
📝 app/Http/Controllers/Api/Application/Servers/ExternalServerController.php (+4 -0)
📝 app/Http/Controllers/Api/Application/Servers/ServerController.php (+10 -0)
📝 app/Http/Controllers/Api/Application/Servers/ServerDetailsController.php (+6 -0)
📝 app/Http/Controllers/Api/Application/Servers/ServerManagementController.php (+12 -0)
📝 app/Http/Controllers/Api/Application/Servers/StartupController.php (+4 -0)
📝 app/Http/Controllers/Api/Application/Users/ExternalUserController.php (+4 -0)
📝 app/Http/Controllers/Api/Application/Users/UserController.php (+16 -0)
📝 app/Http/Controllers/Api/Client/AccountController.php (+7 -0)
📝 app/Http/Controllers/Api/Client/ActivityLogController.php (+2 -0)
📝 app/Http/Controllers/Api/Client/ApiKeyController.php (+6 -0)
📝 app/Http/Controllers/Api/Client/ClientController.php (+6 -0)

...and 24 more files

📄 Description

  • Update scramble to 12
  • Add naming to all endpoints
  • Improve grouping of endpoints
  • Remove remote api docs
  • Make docs homepage a tiny bit nicer :)

Before:
grafik
grafik
grafik
grafik

After:
grafik
grafik
grafik
grafik

🔄 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/pelican-dev/panel/pull/1032 **Author:** [@Boy132](https://github.com/Boy132) **Created:** 2/25/2025 **Status:** ✅ Merged **Merged:** 2/26/2025 **Merged by:** [@Boy132](https://github.com/Boy132) **Base:** `main` ← **Head:** `boy132/improve-api-docs` --- ### 📝 Commits (10+) - [`0d67a5b`](https://github.com/pelican-dev/panel/commit/0d67a5becea84aed867b7b076454d976c5ea3b12) update scramble - [`fadca7c`](https://github.com/pelican-dev/panel/commit/fadca7ca193dea94d18684a2223bc3717b91c675) cleanup application api endpoints - [`e61e97c`](https://github.com/pelican-dev/panel/commit/e61e97c88dc46a680ae7ce073d383b3a4eea5263) cleanup client api endpoints - [`2499c14`](https://github.com/pelican-dev/panel/commit/2499c149c0768be6d4f0e4a01715fa7130d87ceb) fix security schema and make docs homepage nicer - [`240ad1e`](https://github.com/pelican-dev/panel/commit/240ad1ef198e99373624ba6b0efc520f0c621d6a) Merge remote-tracking branch 'upstream/main' into boy132/improve-api-docs - [`5d1a313`](https://github.com/pelican-dev/panel/commit/5d1a3132747cd2c9d72c78337148cd758b6c2878) remove duplicate myclabs/deep-copy - [`8281557`](https://github.com/pelican-dev/panel/commit/82815570dea21912221ef122963ef0d41aa2496d) style(api-docs): use Blade template and Tailwind for styling - [`d10def6`](https://github.com/pelican-dev/panel/commit/d10def65afd4a4d376ea15f4309ab59a8485a363) Publish scramble view - [`649d3f3`](https://github.com/pelican-dev/panel/commit/649d3f3a7803601559c603d403edf0b8d49892d2) Use localStorage theme instead of config - [`9482a9e`](https://github.com/pelican-dev/panel/commit/9482a9eb8dc2d8b977f51b5a215e9faf20e59ccd) Update routes/docs.php ### 📊 Changes **44 files changed** (+436 additions, -29 deletions) <details> <summary>View changed files</summary> 📝 `app/Http/Controllers/Api/Application/DatabaseHosts/DatabaseHostController.php` (+10 -0) 📝 `app/Http/Controllers/Api/Application/Eggs/EggController.php` (+4 -0) 📝 `app/Http/Controllers/Api/Application/Mounts/MountController.php` (+18 -0) 📝 `app/Http/Controllers/Api/Application/Nodes/AllocationController.php` (+8 -0) 📝 `app/Http/Controllers/Api/Application/Nodes/NodeConfigurationController.php` (+4 -0) 📝 `app/Http/Controllers/Api/Application/Nodes/NodeController.php` (+12 -0) 📝 `app/Http/Controllers/Api/Application/Nodes/NodeDeploymentController.php` (+4 -0) 📝 `app/Http/Controllers/Api/Application/Roles/RoleController.php` (+10 -0) 📝 `app/Http/Controllers/Api/Application/Servers/DatabaseController.php` (+12 -0) 📝 `app/Http/Controllers/Api/Application/Servers/ExternalServerController.php` (+4 -0) 📝 `app/Http/Controllers/Api/Application/Servers/ServerController.php` (+10 -0) 📝 `app/Http/Controllers/Api/Application/Servers/ServerDetailsController.php` (+6 -0) 📝 `app/Http/Controllers/Api/Application/Servers/ServerManagementController.php` (+12 -0) 📝 `app/Http/Controllers/Api/Application/Servers/StartupController.php` (+4 -0) 📝 `app/Http/Controllers/Api/Application/Users/ExternalUserController.php` (+4 -0) 📝 `app/Http/Controllers/Api/Application/Users/UserController.php` (+16 -0) 📝 `app/Http/Controllers/Api/Client/AccountController.php` (+7 -0) 📝 `app/Http/Controllers/Api/Client/ActivityLogController.php` (+2 -0) 📝 `app/Http/Controllers/Api/Client/ApiKeyController.php` (+6 -0) 📝 `app/Http/Controllers/Api/Client/ClientController.php` (+6 -0) _...and 24 more files_ </details> ### 📄 Description - Update scramble to 12 - Add naming to all endpoints - Improve grouping of endpoints - Remove remote api docs - Make docs homepage a tiny bit nicer :) --- Before: ![grafik](https://github.com/user-attachments/assets/f1181526-5b9f-47e1-ac9d-0cbc36c1a7e9) ![grafik](https://github.com/user-attachments/assets/c57a3b93-ce18-4853-a81d-c98b66bd0a37) ![grafik](https://github.com/user-attachments/assets/d1eae0ea-cd38-45ab-8a5e-b79e392ebeb0) ![grafik](https://github.com/user-attachments/assets/80ef94f9-08a2-46bb-b2b1-20a47ecdb32f) After: ![grafik](https://github.com/user-attachments/assets/b9e53844-51b1-45a1-927d-c4c98785ae30) ![grafik](https://github.com/user-attachments/assets/7383b98d-b66a-4d4b-95db-1270a1c931a4) ![grafik](https://github.com/user-attachments/assets/b323b7af-8f64-4acf-8919-64a1834377ea) ![grafik](https://github.com/user-attachments/assets/e1c4b586-9a8a-421b-9e59-117a3fd313af) --- <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 19:19:28 +03:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
not confirmed
pull-request
Mirrored from GitHub Pull Request
 👑 sponsor
💰 fund
🔴 hard
🟡 medium
🟡 medium
🟡 medium
🟢 easy
🟢 easy
🟢 easy
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
OVERLORD
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/panel#1124
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?