📝 docs: Add documentation

This commit is contained in:
web@ppanel
2025-12-11 03:29:07 +00:00
parent 50e695a1bb
commit 99e7f6062d
135 changed files with 79115 additions and 8 deletions
+13
View File
@@ -0,0 +1,13 @@
---
title: Admin Service API
outline: false
aside: false
---
# Admin Service
Administrative endpoints that power the dashboard, operations, commerce, user management, and analytics modules.
<ClientOnly>
<ScalarIframe spec-url="https://raw.githubusercontent.com/perfect-panel/ppanel-docs/refs/heads/main/public/swagger/admin.json" title="Admin Service" />
</ClientOnly>
+13
View File
@@ -0,0 +1,13 @@
---
title: Common Service API
outline: false
aside: false
---
# Common Service
Shared endpoints (authentication, utilities, helpers) that are reused across both the admin and user panels. The schema is served directly from GitHub so it always reflects the latest backend implementation.
<ClientOnly>
<ScalarIframe spec-url="https://raw.githubusercontent.com/perfect-panel/ppanel-docs/refs/heads/main/public/swagger/common.json" title="Common Service" />
</ClientOnly>
+13
View File
@@ -0,0 +1,13 @@
---
title: Gateway API
outline: false
aside: false
---
# Gateway
Gateway endpoints cover service registration, version discovery, heartbeats, and update orchestration, ensuring each node can report its status and receive rollout commands through the shared `service_name`/`secret` contract.
<ClientOnly>
<ScalarIframe spec-url="https://raw.githubusercontent.com/perfect-panel/ppanel-docs/refs/heads/main/public/swagger/gateway.json" title="Gateway" />
</ClientOnly>
+16
View File
@@ -0,0 +1,16 @@
---
title: API Reference
outline: false
aside: false
---
# API Reference
The API reference now uses Scalar (embedded via iframe) to render the OpenAPI files hosted in [`public/swagger`](https://github.com/perfect-panel/ppanel-docs/tree/main/public/swagger). Each schema has its own dedicated page:
- [Common Service](./common) — shared authentication/utilities used by both user and admin portals.
- [User Service](./user) — subscriptions, orders, tickets, profile management.
- [Admin Service](./admin) — dashboard, maintenance, commerce, logging modules.
- [Gateway](./gateway) — version checks, heartbeats, registration, and update orchestration hooks for edge services.
Pick a service from the sidebar to view the interactive API explorer.
+13
View File
@@ -0,0 +1,13 @@
---
title: User Service API
outline: false
aside: false
---
# User Service
Endpoints for the customer-facing portal: subscriptions, orders, tickets, wallets, and profile management.
<ClientOnly>
<ScalarIframe spec-url="https://raw.githubusercontent.com/perfect-panel/ppanel-docs/refs/heads/main/public/swagger/user.json" title="User Service" />
</ClientOnly>