diff --git a/docs/ModuleApi/classes/PeppermintParsedown.html b/docs/ModuleApi/classes/PeppermintParsedown.html index 67b8399..a2aee6e 100644 --- a/docs/ModuleApi/classes/PeppermintParsedown.html +++ b/docs/ModuleApi/classes/PeppermintParsedown.html @@ -136,10 +136,10 @@
Gets a preview of the current edit state of a given page
", + "name": "PreviewPage", + "group": "Editing", + "permission": [ + { + "name": "Anonymous", + "title": "Anybody may use this call.", + "description": "" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "string", + "optional": false, + "field": "newpage", + "description": "Set to 'yes' if a new page is being created.
" + }, + { + "group": "Parameter", + "type": "string", + "optional": false, + "field": "preview-edit", + "description": "Set to a value to preview an edit of a page.
" + }, + { + "group": "Parameter", + "type": "string", + "optional": false, + "field": "page", + "description": "The page to operate on.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "./modules/page-edit.php", + "groupTitle": "Editing" + }, { "type": "post", "url": "?action=save&page={pageName}", - "title": "Save an edit to a page.", + "title": "Save an edit to a page", "description": "Saves an edit to a page. If an edit conflict is encountered, then a conflict resolution page is returned instead.
", - "name": "EditPage", + "name": "SavePage", "group": "Editing", "permission": [ { @@ -393,51 +438,6 @@ define({ "api": [ "filename": "./modules/page-edit.php", "groupTitle": "Editing" }, - { - "type": "post", - "url": "?action=preview-edit&page={pageName}[&newpage=yes]", - "title": "Get a preview of the page", - "description": "Gets a preview of the current edit state of a given page
", - "name": "PreviewPage", - "group": "Editing", - "permission": [ - { - "name": "Anonymous", - "title": "Anybody may use this call.", - "description": "" - } - ], - "parameter": { - "fields": { - "Parameter": [ - { - "group": "Parameter", - "type": "string", - "optional": false, - "field": "newpage", - "description": "Set to 'yes' if a new page is being created.
" - }, - { - "group": "Parameter", - "type": "string", - "optional": false, - "field": "preview-edit", - "description": "Set to a value to preview an edit of a page.
" - }, - { - "group": "Parameter", - "type": "string", - "optional": false, - "field": "page", - "description": "The page to operate on.
" - } - ] - } - }, - "version": "0.0.0", - "filename": "./modules/page-edit.php", - "groupTitle": "Editing" - }, { "type": "post", "url": "?action=delete", diff --git a/docs/RestApi/api_data.json b/docs/RestApi/api_data.json index 0f7ba83..0861791 100644 --- a/docs/RestApi/api_data.json +++ b/docs/RestApi/api_data.json @@ -322,12 +322,57 @@ "filename": "./modules/page-edit.php", "groupTitle": "Editing" }, + { + "type": "post", + "url": "?action=preview-edit&page={pageName}[&newpage=yes]", + "title": "Get a preview of the page", + "description": "Gets a preview of the current edit state of a given page
", + "name": "PreviewPage", + "group": "Editing", + "permission": [ + { + "name": "Anonymous", + "title": "Anybody may use this call.", + "description": "" + } + ], + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "string", + "optional": false, + "field": "newpage", + "description": "Set to 'yes' if a new page is being created.
" + }, + { + "group": "Parameter", + "type": "string", + "optional": false, + "field": "preview-edit", + "description": "Set to a value to preview an edit of a page.
" + }, + { + "group": "Parameter", + "type": "string", + "optional": false, + "field": "page", + "description": "The page to operate on.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "./modules/page-edit.php", + "groupTitle": "Editing" + }, { "type": "post", "url": "?action=save&page={pageName}", - "title": "Save an edit to a page.", + "title": "Save an edit to a page", "description": "Saves an edit to a page. If an edit conflict is encountered, then a conflict resolution page is returned instead.
", - "name": "EditPage", + "name": "SavePage", "group": "Editing", "permission": [ { @@ -393,51 +438,6 @@ "filename": "./modules/page-edit.php", "groupTitle": "Editing" }, - { - "type": "post", - "url": "?action=preview-edit&page={pageName}[&newpage=yes]", - "title": "Get a preview of the page", - "description": "Gets a preview of the current edit state of a given page
", - "name": "PreviewPage", - "group": "Editing", - "permission": [ - { - "name": "Anonymous", - "title": "Anybody may use this call.", - "description": "" - } - ], - "parameter": { - "fields": { - "Parameter": [ - { - "group": "Parameter", - "type": "string", - "optional": false, - "field": "newpage", - "description": "Set to 'yes' if a new page is being created.
" - }, - { - "group": "Parameter", - "type": "string", - "optional": false, - "field": "preview-edit", - "description": "Set to a value to preview an edit of a page.
" - }, - { - "group": "Parameter", - "type": "string", - "optional": false, - "field": "page", - "description": "The page to operate on.
" - } - ] - } - }, - "version": "0.0.0", - "filename": "./modules/page-edit.php", - "groupTitle": "Editing" - }, { "type": "post", "url": "?action=delete", diff --git a/docs/RestApi/api_project.js b/docs/RestApi/api_project.js index 5f3f4c6..84c8ce2 100644 --- a/docs/RestApi/api_project.js +++ b/docs/RestApi/api_project.js @@ -8,7 +8,7 @@ define({ "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2018-04-22T14:53:29.858Z", + "time": "2018-04-22T14:56:55.195Z", "url": "http://apidocjs.com", "version": "0.17.6" } diff --git a/docs/RestApi/api_project.json b/docs/RestApi/api_project.json index e73b45b..8f2c350 100644 --- a/docs/RestApi/api_project.json +++ b/docs/RestApi/api_project.json @@ -8,7 +8,7 @@ "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2018-04-22T14:53:29.858Z", + "time": "2018-04-22T14:56:55.195Z", "url": "http://apidocjs.com", "version": "0.17.6" } diff --git a/modules/page-edit.php b/modules/page-edit.php index 25d9af3..883e2de 100644 --- a/modules/page-edit.php +++ b/modules/page-edit.php @@ -311,9 +311,9 @@ window.addEventListener("load", function(event) { }); /** - * @api {post} ?action=save&page={pageName} Save an edit to a page. + * @api {post} ?action=save&page={pageName} Save an edit to a page * @apiDescription Saves an edit to a page. If an edit conflict is encountered, then a conflict resolution page is returned instead. - * @apiName EditPage + * @apiName SavePage * @apiGroup Editing * @apiPermission Anonymous *