GSP/Panel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

cleanup

Browse source
This commit is contained in:
Frank Harris 2026-07-02 18:11:32 -05:00
parent a49371c3dd
commit 251af10faf
1190 changed files with 12636 additions and 12476 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/architecture/API_REFERENCE.md
View file

@ -29,7 +29,7 @@ home.php module request
-> optional agent RPC through lib_remote.php
external automation
-> Panel/ogp_api.php
-> Panel/gsp_api.php
-> api_* handler
-> same module/library logic
-> optional agent RPC
@ -51,7 +51,7 @@ Transport:
- XML-RPC over HTTP
- endpoint path `/RPC2`
- wrapper `Panel/includes/lib_remote.php`
- server implementations in `Agent_Linux/ogp_agent.pl` and `Agent-Windows/OGP64/OGP/ogp_agent.pl`
- server implementations in `Agent_Linux/gsp_agent.pl` and `Agent-Windows/GSP64/GSP/gsp_agent.pl`
Primary categories:
@ -70,7 +70,7 @@ See the full command table in:
## Panel Wrapper Methods
Most Panel modules do not build XML-RPC directly. They call `OGPRemoteLibrary`.
Most Panel modules do not build XML-RPC directly. They call `GSPRemoteLibrary`.
| Wrapper Method | Agent Command | Common Modules |
|---|---|---|
@ -90,7 +90,7 @@ Most Panel modules do not build XML-RPC directly. They call `OGPRemoteLibrary`.
Primary endpoint:
- `Panel/ogp_api.php`
- `Panel/gsp_api.php`
Auth model:
@ -99,7 +99,7 @@ Auth model:
- requests can be GET, POST, or JSON body
- host allowlist can be enforced
Top-level API handlers implemented in `ogp_api.php`:
Top-level API handlers implemented in `gsp_api.php`:
| Handler Function | Route Prefix | Purpose |
|---|---|---|
@ -179,7 +179,7 @@ Return shape:
## Internal Module Endpoints
These are not public APIs in the same sense as `ogp_api.php`, but they matter architecturally.
These are not public APIs in the same sense as `gsp_api.php`, but they matter architecturally.
| Endpoint | Module | Purpose |
|---|---|---|
@ -278,18 +278,18 @@ Panel fallback behavior:
Agent cron jobs often execute URLs like:
- `ogp_api.php?gamemanager/start`
- `ogp_api.php?gamemanager/stop`
- `ogp_api.php?gamemanager/restart`
- `ogp_api.php?gamemanager/update&type=steam`
- `ogp_api.php?server_content/run_scheduled_action`
- `gsp_api.php?gamemanager/start`
- `gsp_api.php?gamemanager/stop`
- `gsp_api.php?gamemanager/restart`
- `gsp_api.php?gamemanager/update&type=steam`
- `gsp_api.php?server_content/run_scheduled_action`
This means `ogp_api.php` is part of the scheduler runtime and must stay backward compatible with those generated URLs.
This means `gsp_api.php` is part of the scheduler runtime and must stay backward compatible with those generated URLs.
## Search Coverage Used For This Document
- `sed -n '1,240p' Panel/ogp_api.php`
- `rg -n "^function api_" Panel/ogp_api.php`
- `sed -n '1,240p' Panel/gsp_api.php`
- `rg -n "^function api_" Panel/gsp_api.php`
- `sed -n '1,240p' Panel/status_api.php`
- `find Website/api -maxdepth 1 -type f`
- `sed -n '1,220p' Website/webhook.php`