sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-22 04:23:01 +00:00
Code Activity

Fix bug in update action api docs.

Browse source
This commit is contained in:
Starbeamrainbowlabs 2016-10-19 07:30:59 +01:00
parent cb75928bd0
commit 49a1153083
5 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
RestApiDocs/api_data.js
View file

@ -476,8 +476,8 @@ define({ "api": [
"group": "Parameter", "group": "Parameter",
"type": "string", "type": "string",
"optional": false, "optional": false,
"field": "printable", "field": "mode",
"description": "<p>Set to 'yes' to get a printable version of the specified page instead.</p>" "description": "<p>Optional. The display mode to use. Can hld the following values: 'normal' - The default. Sends a normal page. 'printable' - Sends a printable version of the page. 'contentonly' - Sends only the content of the page, not the extra stuff around it. 'parsedsourceonly' - Sends only the raw rendered source of the page, as it appears just after it has come out of the page parser. Useful for writing external tools (see also the <code>raw</code> action).</p>"
}, },
{ {
"group": "Parameter", "group": "Parameter",
@ -1006,7 +1006,7 @@ define({ "api": [
}, },
{ {
"type": "get", "type": "get",
"url": "?action=move[do=yes]", "url": "?action=update[do=yes]",
"title": "Update the wiki", "title": "Update the wiki",
"description": "<p>Update the wiki by downloading a new version of Pepperminty Wiki from the URL specified in the settings. Note that unless you change the url from it's default, all custom modules installed will be removed. <strong>Note also that this plugin is currently out of date. Use with extreme caution!</strong></p>", "description": "<p>Update the wiki by downloading a new version of Pepperminty Wiki from the URL specified in the settings. Note that unless you change the url from it's default, all custom modules installed will be removed. <strong>Note also that this plugin is currently out of date. Use with extreme caution!</strong></p>",
"name": "Update", "name": "Update",

6
RestApiDocs/api_data.json
View file

@ -476,8 +476,8 @@
"group": "Parameter", "group": "Parameter",
"type": "string", "type": "string",
"optional": false, "optional": false,
"field": "printable", "field": "mode",
"description": "<p>Set to 'yes' to get a printable version of the specified page instead.</p>" "description": "<p>Optional. The display mode to use. Can hld the following values: 'normal' - The default. Sends a normal page. 'printable' - Sends a printable version of the page. 'contentonly' - Sends only the content of the page, not the extra stuff around it. 'parsedsourceonly' - Sends only the raw rendered source of the page, as it appears just after it has come out of the page parser. Useful for writing external tools (see also the <code>raw</code> action).</p>"
}, },
{ {
"group": "Parameter", "group": "Parameter",
@ -1006,7 +1006,7 @@
}, },
{ {
"type": "get", "type": "get",
"url": "?action=move[do=yes]", "url": "?action=update[do=yes]",
"title": "Update the wiki", "title": "Update the wiki",
"description": "<p>Update the wiki by downloading a new version of Pepperminty Wiki from the URL specified in the settings. Note that unless you change the url from it's default, all custom modules installed will be removed. <strong>Note also that this plugin is currently out of date. Use with extreme caution!</strong></p>", "description": "<p>Update the wiki by downloading a new version of Pepperminty Wiki from the URL specified in the settings. Note that unless you change the url from it's default, all custom modules installed will be removed. <strong>Note also that this plugin is currently out of date. Use with extreme caution!</strong></p>",
"name": "Update", "name": "Update",

2
RestApiDocs/api_project.js
View file

@ -6,7 +6,7 @@ define({
"apidoc": "0.2.0", "apidoc": "0.2.0",
"generator": { "generator": {
"name": "apidoc", "name": "apidoc",
"time": "2016-10-13T16:58:55.359Z", "time": "2016-10-19T06:30:15.660Z",
"url": "http://apidocjs.com", "url": "http://apidocjs.com",
"version": "0.16.1" "version": "0.16.1"
} }

2
RestApiDocs/api_project.json
View file

@ -6,7 +6,7 @@
"apidoc": "0.2.0", "apidoc": "0.2.0",
"generator": { "generator": {
"name": "apidoc", "name": "apidoc",
"time": "2016-10-13T16:58:55.359Z", "time": "2016-10-19T06:30:15.660Z",
"url": "http://apidocjs.com", "url": "http://apidocjs.com",
"version": "0.16.1" "version": "0.16.1"
} }

4
modules/page-update.php
View file

@ -1,14 +1,14 @@
<?php <?php
register_module([ register_module([
"name" => "Update", "name" => "Update",
"version" => "0.6.1", "version" => "0.6.2",
"author" => "Starbeamrainbowlabs", "author" => "Starbeamrainbowlabs",
"description" => "Adds an update page that downloads the latest stable version of Pepperminty Wiki. This module is currently outdated as it doesn't save your module preferences.", "description" => "Adds an update page that downloads the latest stable version of Pepperminty Wiki. This module is currently outdated as it doesn't save your module preferences.",
"id" => "page-update", "id" => "page-update",
"code" => function() { "code" => function() {
/** /**
* @api {get} ?action=move[do=yes] Update the wiki * @api {get} ?action=update[do=yes] Update the wiki
* @apiDescription Update the wiki by downloading a new version of Pepperminty Wiki from the URL specified in the settings. Note that unless you change the url from it's default, all custom modules installed will be removed. **Note also that this plugin is currently out of date. Use with extreme caution!** * @apiDescription Update the wiki by downloading a new version of Pepperminty Wiki from the URL specified in the settings. Note that unless you change the url from it's default, all custom modules installed will be removed. **Note also that this plugin is currently out of date. Use with extreme caution!**
* @apiName Update * @apiName Update
* @apiGroup Utility * @apiGroup Utility