"description":"<p>The user name to login with.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"password",
"description":"<p>The password to login with.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"returnto",
"description":"<p>The URL to redirect to upon a successful login.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"InvalidCredentialsError",
"description":"<p>The supplied credentials were invalid. Note that this error is actually a redirect to ?action=login&failed=yes (with the returnto parameter appended if you supplied one)</p>"
"description":"<p>The user name to login with.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"password",
"description":"<p>The password to login with.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"returnto",
"description":"<p>The URL to redirect to upon a successful login.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"InvalidCredentialsError",
"description":"<p>The supplied credentials were invalid. Note that this error is actually a redirect to ?action=login&failed=yes (with the returnto parameter appended if you supplied one)</p>"
"description":"<p>Setting to yes causes a login failure message to be displayed above the login form.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"returnto",
"description":"<p>Set to the url to redirect to upon a successful login.</p>"
}
]
}
},
"version":"0.0.0",
"filename":"./modules/page-login.php",
"groupTitle":"Authorisation"
},
{
"type":"post",
"url":"?action=logout",
"title":"Logout",
"description":"<p>Logout. Make sure that your bot requests this URL when it is finished - this call not only clears your cookies but also clears the server's session file as well. Note that you can request this when you are already logged out and it will completely wipe your session on the server.</p>",
"description":"<p>Logout. Make sure that your bot requests this URL when it is finished - this call not only clears your cookies but also clears the server's session file as well. Note that you can request this when you are already logged out and it will completely wipe your session on the server.</p>",
"name":"Logout",
"group":"Authorisation",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"version":"0.0.0",
"filename":"./modules/page-logout.php",
"groupTitle":"Authorisation"
},
{
"type":"post",
"url":"?action=comment",
"title":"Comment on a page",
"name":"Comment",
"group":"Comment",
"permission":[
{
"name":"User",
"title":"Only users loggged in may use this call.",
"description":""
}
],
"description":"<p>Posts a comment on a page, optionally in reply to another comment. Currently, comments must be made by a logged-in user.</p>",
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"message",
"description":"<p>The comment text. Supports the same syntax that the renderer of the main page supports. The default is extended markdown - see the help page of the specific wiki for more information.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"replyto",
"description":"<p>Optional. If specified the comment will be posted in reply to the comment with the specified id.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"CommentNotFound",
"description":"<p>The comment to reply to was not found.</p>"
"title":"Only users loggged in may use this call.",
"description":""
}
],
"description":"<p>Posts a comment on a page, optionally in reply to another comment. Currently, comments must be made by a logged-in user.</p>",
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"message",
"description":"<p>The comment text. Supports the same syntax that the renderer of the main page supports. The default is extended markdown - see the help page of the specific wiki for more information.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"replyto",
"description":"<p>Optional. If specified the comment will be posted in reply to the comment with the specified id.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"CommentNotFound",
"description":"<p>The comment to reply to was not found.</p>"
"description":"<p>Saves an edit to a page. If an edit conflict is encountered, then a conflict resolution page is returned instead.</p>",
"name":"EditPage",
"group":"Page",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"newpage",
"description":"<p>GET only. Set to 'yes' to indicate that this is a new page that is being saved. Only affects the HTTP response code you recieve upon success.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"content",
"description":"<p>POST only. The new content to save to the given filename.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"tags",
"description":"<p>POST only. A comma-separated list of tags to assign to the current page. Will replace the existing list of tags, if any are present.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"prev-content-hash",
"description":"<p>POST only. The hash of the original content before editing. If this hash is found to be different to a hash computed of the currentl saved content, a conflict resolution page will be returned instead of saving the provided content.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"page",
"description":"<p>The page to operate on.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"UnsufficientPermissionError",
"description":"<p>You don't currently have sufficient permissions to save an edit.</p>"
"description":"<p>GET only. Set to 'yes' to indicate that this is a new page that is being saved. Only affects the HTTP response code you recieve upon success.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"content",
"description":"<p>POST only. The new content to save to the given filename.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"tags",
"description":"<p>POST only. A comma-separated list of tags to assign to the current page. Will replace the existing list of tags, if any are present.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"prev-content-hash",
"description":"<p>POST only. The hash of the original content before editing. If this hash is found to be different to a hash computed of the currentl saved content, a conflict resolution page will be returned instead of saving the provided content.</p>"
"description":"<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name":"EditPage",
"group":"Page",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"newpage",
"description":"<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
"description":"<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"description":"<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
"description":"<p>The revision number to display.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"mode",
"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",
"type":"string",
"optional":false,
"field":"page",
"description":"<p>The page to operate on.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"NonExistentPageError",
"description":"<p>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.</p>"
},
{
"group":"Error 4xx",
"optional":false,
"field":"NonExistentRevisionError",
"description":"<p>The specified revision was not found.</p>"
"description":"<p>The revision number to display.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"mode",
"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",
"type":"string",
"optional":false,
"field":"page",
"description":"<p>The page to operate on.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"NonExistentPageError",
"description":"<p>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.</p>"
},
{
"group":"Error 4xx",
"optional":false,
"field":"NonExistentRevisionError",
"description":"<p>The specified revision was not found.</p>"
"description":"<p>The name of the file to preview.</p>"
},
{
"group":"Parameter",
"type":"number",
"optional":false,
"field":"size",
"description":"<p>Optional. The size fo the resulting preview. Will be clamped to fit within the bounds specified in the wiki's settings. May also be set to the keyword 'original', which will cause the original file to be returned with it's appropriate mime type instead.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"PreviewNoFileError",
"description":"<p>No file was found associated with the specified page.</p>"
},
{
"group":"Error 4xx",
"optional":false,
"field":"PreviewUnknownFileTypeError",
"description":"<p>Pepperminty Wiki was unable to generate a preview for the requested file's type.</p>"
"description":"<p>The name of the file to preview.</p>"
},
{
"group":"Parameter",
"type":"number",
"optional":false,
"field":"size",
"description":"<p>Optional. The size fo the resulting preview. Will be clamped to fit within the bounds specified in the wiki's settings. May also be set to the keyword 'original', which will cause the original file to be returned with it's appropriate mime type instead.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"PreviewNoFileError",
"description":"<p>No file was found associated with the specified page.</p>"
},
{
"group":"Error 4xx",
"optional":false,
"field":"PreviewUnknownFileTypeError",
"description":"<p>Pepperminty Wiki was unable to generate a preview for the requested file's type.</p>"
"description":"<p>You weren't loggged in as a moderator before sending this request.</p>"
}
]
}
}
},
{
"type":"get",
"url":"?action=debug",
"title":"Get a debug dump",
"name":"Debug",
"group":"Utility",
"permission":[
{
"name":"Moderator",
"title":"Only users loggged with a moderator account may use this call.",
"description":""
}
],
"version":"0.0.0",
"filename":"./modules/page-debug-info.php",
"groupTitle":"Utility",
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"UserNotModeratorError",
"description":"<p>You weren't loggged in as a moderator before sending this request.</p>"
}
]
}
}
},
{
"type":"get",
"url":"?action=export",
"title":"Export the all the wiki's content",
"description":"<p>Export all the wiki's content. Please ask for permission before making a request to this URI. Note that some wikis may only allow moderators to export content.</p>",
"name":"Export",
"group":"Utility",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"InsufficientExportPermissionsError",
"description":"<p>The wiki has the export_allow_only_admins option turned on, and you aren't logged into a moderator account.</p>"
},
{
"group":"Error 4xx",
"optional":false,
"field":"CouldntOpenTempFileError",
"description":"<p>Pepperminty Wiki couldn't open a temporary file to send the compressed archive to.</p>"
},
{
"group":"Error 4xx",
"optional":false,
"field":"CouldntCloseTempFileError",
"description":"<p>Pepperminty Wiki couldn't close the temporary file to finish creating the zip archive ready for downloading.</p>"
}
]
}
},
"version":"0.0.0",
"filename":"./modules/page-export.php",
"groupTitle":"Utility"
},
{
"type":"get",
"url":"?action=export",
"title":"Export the all the wiki's content",
"description":"<p>Export all the wiki's content. Please ask for permission before making a request to this URI. Note that some wikis may only allow moderators to export content.</p>",
"name":"Export",
"group":"Utility",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"InsufficientExportPermissionsError",
"description":"<p>The wiki has the export_allow_only_admins option turned on, and you aren't logged into a moderator account.</p>"
},
{
"group":"Error 4xx",
"optional":false,
"field":"CouldntOpenTempFileError",
"description":"<p>Pepperminty Wiki couldn't open a temporary file to send the compressed archive to.</p>"
},
{
"group":"Error 4xx",
"optional":false,
"field":"CouldntCloseTempFileError",
"description":"<p>Pepperminty Wiki couldn't close the temporary file to finish creating the zip archive ready for downloading.</p>"
"description":"<p>Whether to return the hashed password as a raw string instead of as part of an HTML page.</p>"
}
]
}
},
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"ParamNotFound",
"description":"<p>The string parameter was not specified.</p>"
}
]
}
},
"version":"0.0.0",
"filename":"./modules/action-hash.php",
"groupTitle":"Utility"
},
{
"type":"get",
"url":"?action=help[&dev=yes]",
"title":"Get a help page",
"description":"<p>Get a customised help page. This page will be slightly different for every wiki, depending on their name, settings, and installed modules.</p>",
"name":"Help",
"group":"Utility",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"dev",
"description":"<p>Set to 'yes' to get a developer help page instead. The developer help page gives some general information about which modules and help page sections are registered, and other various (non-sensitive) settings.</p>"
"description":"<p>Get a customised help page. This page will be slightly different for every wiki, depending on their name, settings, and installed modules.</p>",
"name":"Help",
"group":"Utility",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"dev",
"description":"<p>Set to 'yes' to get a developer help page instead. The developer help page gives some general information about which modules and help page sections are registered, and other various (non-sensitive) settings.</p>"
}
]
}
},
"version":"0.0.0",
"filename":"./modules/page-help.php",
"groupTitle":"Utility"
},
{
"type":"get",
"url":"?action=list-tags[&tag=]",
"title":"Get a list of tags or pages with a certain tag",
"description":"<p>Gets a list of all tags on the wiki. Adding the <code>tag</code> parameter causes a list of pages with the given tag to be returned instead.</p>",
"name":"ListTags",
"group":"Utility",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"tag",
"description":"<p>Optional. If provided a list of all the pages with that tag is returned instead.</p>"
"title":"Get a list of tags or pages with a certain tag",
"description":"<p>Gets a list of all tags on the wiki. Adding the <code>tag</code> parameter causes a list of pages with the given tag to be returned instead.</p>",
"name":"ListTags",
"group":"Utility",
"permission":[
{
"name":"Anonymous",
"title":"Anybody may use this call.",
"description":""
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"tag",
"description":"<p>Optional. If provided a list of all the pages with that tag is returned instead.</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",
"group":"Utility",
"permission":[
{
"name":"Moderator",
"title":"Only users loggged with a moderator account may use this call.",
"description":""
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"do",
"description":"<p>Set to 'yes' to actually do the upgrade. Omission causes a page asking whether an update is desired instead.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"secret",
"description":"<p>The wiki's secret string that's stored in the settings.</p>"
},
{
"group":"Parameter",
"optional":false,
"field":"InvalidSecretError",
"description":"<p>The supplied secret doesn't match up with the secret stored in the wiki's settings.</p>"
"description":"<p>You weren't loggged in as a moderator before sending this request.</p>"
}
]
}
}
},
{
"type":"get",
"url":"?action=update[do=yes]",
"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>",
"name":"Update",
"group":"Utility",
"permission":[
{
"name":"Moderator",
"title":"Only users loggged with a moderator account may use this call.",
"description":""
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"do",
"description":"<p>Set to 'yes' to actually do the upgrade. Omission causes a page asking whether an update is desired instead.</p>"
},
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"secret",
"description":"<p>The wiki's secret string that's stored in the settings.</p>"
},
{
"group":"Parameter",
"optional":false,
"field":"InvalidSecretError",
"description":"<p>The supplied secret doesn't match up with the secret stored in the wiki's settings.</p>"
}
]
}
},
"version":"0.0.0",
"filename":"./modules/page-update.php",
"groupTitle":"Utility",
"error":{
"fields":{
"Error 4xx":[
{
"group":"Error 4xx",
"optional":false,
"field":"UserNotModeratorError",
"description":"<p>You weren't loggged in as a moderator before sending this request.</p>"
}
]
}
}
},
{
"type":"get|post",
"url":"?action=stats-update",
"title":"Recalculate the wiki's statistics",
"name":"UpdateStats",
"group":"Utility",
"permission":[
{
"name":"Administrator"
}
],
"parameter":{
"fields":{
"Parameter":[
{
"group":"Parameter",
"type":"string",
"optional":false,
"field":"secret",
"description":"<p>POST only, optional. If you're not logged in, you can specify the wiki's sekret (find it in peppermint.json) using this parameter.</p>"
"description":"<p>POST only, optional. If you're not logged in, you can specify the wiki's sekret instead (find it in peppermint.json) using this parameter.</p>"
},
{
"group":"Parameter",
"type":"bool",
"optional":false,
"field":"force",
"description":"<p>Whether the statistics should be recalculated anyway - even if they have already recently been recalculated. Default: no. Supported values: yes, no.</p>"
