mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-11-26 05:32:59 +00:00
Add minified option to status action
This commit is contained in:
parent
5af29c133f
commit
1c30d2543b
4 changed files with 14 additions and 7 deletions
|
@ -19,6 +19,7 @@ This file holds the changelog for Pepperminty Wiki. This is the master list of t
|
||||||
- You'll need to rebuild your search index for this fix to fully take effect (call the `invindex-rebuild` action as a mod or better)
|
- You'll need to rebuild your search index for this fix to fully take effect (call the `invindex-rebuild` action as a mod or better)
|
||||||
- Normalise utf8 text to avoid duplicate ids and missing search results.
|
- Normalise utf8 text to avoid duplicate ids and missing search results.
|
||||||
- Improved handling of mime types in some places in the API.
|
- Improved handling of mime types in some places in the API.
|
||||||
|
- Added `minified` option to `status` action to reduce data usage slightly
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Disallow uploads if editing is disabled. Previously files could still be uploaded even if editing was disabled - unless `upload_enabled` was set to `false`.
|
- Disallow uploads if editing is disabled. Previously files could still be uploaded even if editing was disabled - unless `upload_enabled` was set to `false`.
|
||||||
|
|
|
@ -2368,11 +2368,12 @@ register_module([
|
||||||
"code" => function() {
|
"code" => function() {
|
||||||
global $settings;
|
global $settings;
|
||||||
/**
|
/**
|
||||||
* @api {get} ?action=status Get the json-formatted status of this wiki
|
* @api {get} ?action=status[&minified=type] Get the json-formatted status of this wiki
|
||||||
* @apiName Status
|
* @apiName Status
|
||||||
* @apiGroup Stats
|
* @apiGroup Stats
|
||||||
* @apiPermission Anonymous
|
* @apiPermission Anonymous
|
||||||
*
|
*
|
||||||
|
* @apiParam {boolean} Whether or not the result should be minified JSON. Default: false
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
@ -2387,6 +2388,8 @@ register_module([
|
||||||
exit("Unfortunately, this API is currently only available in application/json at the moment, which you haven't indicated you accept in your http accept header. You said this in your accept header:\n" . $_SERVER["HTTP_ACCEPT"]);
|
exit("Unfortunately, this API is currently only available in application/json at the moment, which you haven't indicated you accept in your http accept header. You said this in your accept header:\n" . $_SERVER["HTTP_ACCEPT"]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$minified = ($_GET["minified"] ?? "false") == "true";
|
||||||
|
|
||||||
$action_names = array_keys(get_object_vars($actions));
|
$action_names = array_keys(get_object_vars($actions));
|
||||||
sort($action_names);
|
sort($action_names);
|
||||||
|
|
||||||
|
@ -2398,7 +2401,7 @@ register_module([
|
||||||
$result->logo_url = $settings->favicon;
|
$result->logo_url = $settings->favicon;
|
||||||
|
|
||||||
header("content-type: application/json");
|
header("content-type: application/json");
|
||||||
exit(json_encode($result, JSON_PRETTY_PRINT) . "\n");
|
exit($minified ? json_encode($result) : json_encode($result, JSON_PRETTY_PRINT) . "\n");
|
||||||
});
|
});
|
||||||
|
|
||||||
add_help_section("960-api-status", "Wiki Status API", "<p></p>");
|
add_help_section("960-api-status", "Wiki Status API", "<p></p>");
|
||||||
|
|
|
@ -41,7 +41,7 @@
|
||||||
"author": "Starbeamrainbowlabs",
|
"author": "Starbeamrainbowlabs",
|
||||||
"description": "Provides a basic JSON status action that provices a few useful bits of information for API consumption.",
|
"description": "Provides a basic JSON status action that provices a few useful bits of information for API consumption.",
|
||||||
"id": "api-status",
|
"id": "api-status",
|
||||||
"lastupdate": 1522166256,
|
"lastupdate": 1522167607,
|
||||||
"optional": false
|
"optional": false
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
@ -8,11 +8,12 @@ register_module([
|
||||||
"code" => function() {
|
"code" => function() {
|
||||||
global $settings;
|
global $settings;
|
||||||
/**
|
/**
|
||||||
* @api {get} ?action=status Get the json-formatted status of this wiki
|
* @api {get} ?action=status[&minified=type] Get the json-formatted status of this wiki
|
||||||
* @apiName Status
|
* @apiName Status
|
||||||
* @apiGroup Stats
|
* @apiGroup Stats
|
||||||
* @apiPermission Anonymous
|
* @apiPermission Anonymous
|
||||||
*
|
*
|
||||||
|
* @apiParam {boolean} Whether or not the result should be minified JSON. Default: false
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
@ -27,6 +28,8 @@ register_module([
|
||||||
exit("Unfortunately, this API is currently only available in application/json at the moment, which you haven't indicated you accept in your http accept header. You said this in your accept header:\n" . $_SERVER["HTTP_ACCEPT"]);
|
exit("Unfortunately, this API is currently only available in application/json at the moment, which you haven't indicated you accept in your http accept header. You said this in your accept header:\n" . $_SERVER["HTTP_ACCEPT"]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$minified = ($_GET["minified"] ?? "false") == "true";
|
||||||
|
|
||||||
$action_names = array_keys(get_object_vars($actions));
|
$action_names = array_keys(get_object_vars($actions));
|
||||||
sort($action_names);
|
sort($action_names);
|
||||||
|
|
||||||
|
@ -38,7 +41,7 @@ register_module([
|
||||||
$result->logo_url = $settings->favicon;
|
$result->logo_url = $settings->favicon;
|
||||||
|
|
||||||
header("content-type: application/json");
|
header("content-type: application/json");
|
||||||
exit(json_encode($result, JSON_PRETTY_PRINT) . "\n");
|
exit($minified ? json_encode($result) : json_encode($result, JSON_PRETTY_PRINT) . "\n");
|
||||||
});
|
});
|
||||||
|
|
||||||
add_help_section("960-api-status", "Wiki Status API", "<p></p>");
|
add_help_section("960-api-status", "Wiki Status API", "<p></p>");
|
||||||
|
|
Loading…
Reference in a new issue