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

Document redirect and redirected_from GET params to the view action

Browse source
This commit is contained in:
Starbeamrainbowlabs 2022-08-14 21:41:17 +01:00
parent c767ab6621
commit b2ba00df56
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Changelog.md
View file

@ -4,7 +4,7 @@ This file holds the changelog for Pepperminty Wiki. This is the master list of t
## v0.24-beta2 ## v0.24-beta2
- **Added:** `filter` GET parameter to the `list` action, which filters the list of pages to contain only those containing the specified substring. - **Added:** `filter` GET parameter to the `list` action, which filters the list of pages to contain only those containing the specified substring.
- **Fixed:** [Rest API] Documented `redirect` and `redirected_from` GET params to the `view` action.
## v0.24-beta1 ## v0.24-beta1

4
modules/page-view.php
View file

@ -5,7 +5,7 @@
register_module([ register_module([
"name" => "Page viewer", "name" => "Page viewer",
"version" => "0.16.11", "version" => "0.16.12",
"author" => "Starbeamrainbowlabs", "author" => "Starbeamrainbowlabs",
"description" => "Allows you to view pages. You really should include this one.", "description" => "Allows you to view pages. You really should include this one.",
"id" => "page-view", "id" => "page-view",
@ -23,6 +23,8 @@ register_module([
* @apiUse PageParameter * @apiUse PageParameter
* @apiParam {number} revision The revision number to display. * @apiParam {number} revision The revision number to display.
* @apiParam {string} mode Optional. The display mode to use. Can hold 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 `raw` action). * @apiParam {string} mode Optional. The display mode to use. Can hold 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 `raw` action).
* @apiParam {string} redirect Optional. If set to 'no' (without quotes), causes the specified page to be shown - even if it would normally result in a redirect.
* @apiParam {string} redirected_from Optional. Cosmetic parameter that displays the name of the page that was redirected from. You will not normally need to use this.
* *
* @apiError NonExistentPageError The page doesn't exist and editing is disabled in the wiki's settings. If editing isn't disabled, you will be redirected to the edit page instead. * @apiError NonExistentPageError The page doesn't exist and editing is disabled in the wiki's settings. If editing isn't disabled, you will be redirected to the edit page instead.
* @apiError NonExistentRevisionError The specified revision was not found. * @apiError NonExistentRevisionError The specified revision was not found.