1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-21 16:13:00 +00:00

action-raw: updaate rest api docs

This commit is contained in:
Starbeamrainbowlabs 2022-06-30 01:39:56 +01:00
parent 234f9fa371
commit ec340d18a9
Signed by: sbrl
GPG key ID: 1BE5172E637709C2

View file

@ -5,7 +5,7 @@
register_module([ register_module([
"name" => "Raw page source", "name" => "Raw page source",
"version" => "0.9", "version" => "0.9.1",
"author" => "Starbeamrainbowlabs", "author" => "Starbeamrainbowlabs",
"description" => "Adds a 'raw' action that shows you the raw source of a page.", "description" => "Adds a 'raw' action that shows you the raw source of a page.",
"id" => "action-raw", "id" => "action-raw",
@ -19,6 +19,14 @@ register_module([
* *
* @apiParam {string} page The page to return the source of. * @apiParam {string} page The page to return the source of.
* @apiParam {string} typeheader Optional; v0.22+. The content-type header to set on the response. If not set, defaults to text/markdown. Valid values: plaintext (returns text/plain). Does NOT change the content delivered. Useful for debugging if your browser doesn't display text returned with text/markdown. * @apiParam {string} typeheader Optional; v0.22+. The content-type header to set on the response. If not set, defaults to text/markdown. Valid values: plaintext (returns text/plain). Does NOT change the content delivered. Useful for debugging if your browser doesn't display text returned with text/markdown.
*
* @apiSuccessExample Example response:
* HTTP/1.1 200 OK
* content-type: text/markdown
* content-disposition: inline
* x-tags: foo, bar, baz
*
* Some text here
*/ */
/* /*