API Reference

1. Overview
1. 1. 1. 1.1.1.1. Configuration
    2. 1.1.1.2. Features
2. Implementation Notes

Overview

Assembly: mindtouch.deki
Class: MindTouch.Deki.DekiWikiService
SID: sid://mindtouch.com/2006/11/dekiwiki

Configuration

Name	Type	Description
admin-db-password	string	Database administrator password.
admin-db-user	string?	Database administrator user name (default: root).
apikey	string?	Key to access protected features of the service.
authtoken-salt	string	Private key used to generate unique auth tokens
autosave	double?	Time interval in seconds for automatic state save (only applies to services with state).
banned-words	string?	Comma separated list of banned words
deki-db-catalog	string?	Database table name (default: wikidb).
deki-db-options	string	Optional connection string parameters
deki-db-password	string	Password for database user.
deki-db-port	int?	Database port (default: 3306).
deki-db-server	string?	Database host name (default: localhost).
deki-db-user	string?	Database user name (default: wikiuser).
deki-language	string?	Site language (default: en-US).
deki-path	string	Deki installation folder
deki-resources-path	string?	Path to Deki resources folder (default: %deki-path%/resources)
deki-sitename	string?	Site name (default: Deki Wiki).
html2ps-path	string?	Path to html2ps tool (default: /usr/bin/html2ps)
imagemagick-convert-path	string	Path to ImageMagick converter tool
imagemagick-identify-path	string	Path to ImageMagick identify tool
max-image-size	int?	Maximum supported image size in bytes or 0 for no limit (default: 0).
ps2pdf-path	string?	Path to ps2pdf tool (default: /usr/bin/ps2pdf)
uri.log	uri?	Uri for logging service.
uri.self	uri	Uri for current service (provided by Host).

Features

Name	Description
DELETE:	Stop service
DELETE:archive/files/{fileid}	Remove a file from the archive (wipe)
DELETE:archive/files	Removes all files from the archive (wipe)
DELETE:files/{fileid}/description	Reset the file description
DELETE:files/{fileid}	Delete file attachment
DELETE:groups/{groupid}	Remove a group
DELETE:pages/{pageid}/comments/{commentnumber}	Mark a comment as being deleted. This hides comment content from non admins
DELETE:pages/{pageid}/files/{filename}/description	Reset the file description
DELETE:pages/{pageid}/files/{filename}	Delete file attachment
DELETE:pages/{pageid}/security	Reset page restricts and grants
DELETE:pages/{pageid}	Deletes a page and optionally descendant pages by moving them to the archive
DELETE:site/logo.png	Remove the site logo
DELETE:site/logo	Remove the site logo
GET:	Retrieve extension description
GET:archive/files/{fileid}/{filename}	Retrieve file attachment content
GET:archive/files/{fileid}/info	Retrieves file info for a deleted file
GET:archive/files/{fileid}	Retrieves file content for a deleted file
GET:archive/files	Retrieves file info for all deleted files
GET:archive/pages/{pageid}/contents	Retrieve the contents of a deleted page for previewing
GET:archive/pages/{pageid}/info	Retrieve basic page information for the deleted page
GET:archive/pages/{pageid}/subpages	Retrieve the child pages that were deleted as well from deleting the given page
GET:archive/pages/{pageid}	Retrieve basic page information for the deleted page
GET:archive/pages	Retrieve the pages that can be potentially restored from deletion.
GET:archive	Retrieves a summary of available archive information
GET:files/{fileid}/{filename}	Retrieve file attachment content
GET:files/{fileid}/description	retrieves a file description
GET:files/{fileid}/info	Retrieve file attachment information
GET:files/{fileid}/revisions	Retrieve file revision info
GET:files/{fileid}	Retrieve file attachment content
GET:files/{name}	Retrieve file contents
GET:files	Retrieve information for all attached files
GET:groups/{groupid}/users	Return a list of users in a group
GET:groups/{groupid}	Retrieve group information
GET:groups	Retrieve list of groups.
GET:logo.png	Retrieve MindTouch Deki Wiki logo
GET:pages/{pageid}/aliases	Retrieve list of page aliases
GET:pages/{pageid}/comments/{commentnumber}/content	Retrieve the comment text only
GET:pages/{pageid}/comments/{commentnumber}	Retrieve a comment and metadata
GET:pages/{pageid}/comments	Retrieve the comments on a page
GET:pages/{pageid}/contents	Retrieve the contents of a page.
GET:pages/{pageid}/diff	Show changes between revisions
GET:pages/{pageid}/export	Export a page to the specified format
GET:pages/{pageid}/feed	Retrieve feed of page changes
GET:pages/{pageid}/files,subpages	Retrieves a list of files and subpages for a given page
GET:pages/{pageid}/files/{filename}/description	retrieves a file description
GET:pages/{pageid}/files/{filename}/info	Retrieve file attachment information
GET:pages/{pageid}/files/{filename}/revisions	Retrieve file revision info
GET:pages/{pageid}/files/{filename}	Retrieve file attachment content
GET:pages/{pageid}/files	Retrieves a list of files for a given page
GET:pages/{pageid}/info	Retrieve page information
GET:pages/{pageid}/links	Retrieve list of inbound or outbound page links
GET:pages/{pageid}/properties	Retrieves page properties.
GET:pages/{pageid}/revisions	Retrieve revision history of a given title
GET:pages/{pageid}/security	Retrieve page security info
GET:pages/{pageid}/subpages	Retrieve list of sub-pages
GET:pages/{pageid}/tags	Retrieve the tags on a page.
GET:pages/{pageid}/tree	Builds a site map starting from a given page.
GET:pages/{pageid}	Retrieve aggregate page information including attachments
GET:pages/popular	Retrieves a list of popular pages.
GET:pages	Builds a site map starting from 'home' page.
GET:site/feed	Retrieve feed of site changes
GET:site/functions	Get list of available extensions
GET:site/logo.png	Retrieve the site logo image
GET:site/logo	Retrieve the site logo image
GET:site/nav/{pageid}/children,siblings	Retrieve <div> tags for the sub-pages and sibling pages of the given page.
GET:site/nav/{pageid}/children	Retrieve <div> tags for the sub-pages of the given page.
GET:site/nav/{pageid}/full	Retrieve <div> tags of the full navigation tree for the given page.
GET:site/nav/{pageid}/siblings	Retrieve <div> tags for sibling pages of the given page.
GET:site/opensearch/description	Get the OpenSearch Description document
GET:site/opensearch/suggestions	Search the Deki index
GET:site/opensearch	Search the Deki index
GET:site/operations	Retrieve all known security operations
GET:site/roles/{roleid}	Retrieve a role
GET:site/roles	Retrieve list of defined roles
GET:site/search	Search the Deki index
GET:site/services/{id}	Retrieve service.
GET:site/services	Retrieve list of services.
GET:site/settings	Retrieve all configuration settings
GET:users/{userid}/favorites/feed	Retrieve feed of user favorites changes
GET:users/{userid}/feed	Retrieve feed of user contributions
GET:users/{userid}	Retrieve information about a user.
GET:users/authenticate	Authenticate a user given http header Credentials or an auth token. Response status 200 implies valid credentials and contains a new auth token.
GET:users	Retrieve list of users.
HEAD:files/{fileid}/{filename}	Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests)
HEAD:files/{fileid}	Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests)
HEAD:files/{name}	Retrieve file headers
HEAD:pages/{pageid}/files/{filename}	Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests)
POST:{function}	Invoke extension function
POST:archive/files/restore/{fileid}	Restores a deleted file back to its page
POST:archive/pages/{pageid}/restore	Restore all revisions of a given page
POST:files/{fileid}/index	re-index an attachment
POST:files/{fileid}/move	Move an attachment from one page to another
POST:groups	Add or modify a group
POST:pages/{pageid}/comments	Post a new comment to a page
POST:pages/{pageid}/contents	Update contents of a page
POST:pages/{pageid}/index	re-index a page and it's attributes
POST:pages/{pageid}/move	Move page to a new location
POST:pages/{pageid}/revert	Revert page to an earlier revision
POST:pages/{pageid}/security	Modify page security by adding and removing grants
POST:site/search/rebuild	Rebuild the Deki Lucene index
POST:site/services/{id}	Update and restart a service
POST:site/services	Update and restart all local services
POST:users/{userid}/allowed	Check one or more resources if given operation is allowed.
POST:users/authenticate	Authenticate a user given http header Credentials or an auth token. When using external authentication, this will automatically create an account and synchronize groups. Response status 200 implies valid credentials and contains a new auth token.
POST:users	Add or modify a user
PUT:files/{fileid}/description	Update attachment description
PUT:groups/{groupid}/users	Set the members for a group
PUT:groups/{groupid}	Modify an existing group
PUT:pages/{pageid}/comments/{commentnumber}/content	Edit the specified comment
PUT:pages/{pageid}/files/{filename}/description	Update attachment description
PUT:pages/{pageid}/files/{filename}	Upload file attachment
PUT:pages/{pageid}/properties	Update page properties.
PUT:pages/{pageid}/security	Set page security info
PUT:pages/{pageid}/tags	Sets the tags on a page.
PUT:site/logo.png	Save a new site logo image
PUT:site/logo	Save a new site logo image
PUT:site/roles/{roleid}	Modify or add a role
PUT:site/settings	Set all configuration settings
PUT:users/{userid}/password	Set password for a given user.
PUT:users/{userid}	Modify an existing user

Implementation Notes

To learn more about a particular feature, click on the corresponding link above.

Retrieved from "http://wiki.developer.mindtouch.com/MindTouch_Deki/API_Reference"

Tag page
What links here

Files 0

Attach file or image

Images 0

Viewing 2 of 2 comments: view all

chailatte says:

How was this documentation generated? Is there a tool or process that can automatically generate documentation from the code into dekiwiki, or was this added to by hand? Thanks!

Posted 22:37, 9 May 2008

BrigetteK says:

It was auto-generated with the blueprints tool (available with the Dream SDK or in SVN under public\dream\trunk\src\mindtouch.blueprints.

Use:

mindtouch.blueprints.exe -url=<url of your wiki api> -login=<your login> -password=<your password> <location of the dll for which to generate documentation>

Example:

mindtouch.blueprints.exe -url=http://deki-hayes/@api/deki -login=Admin -password=password /var/www/deki-hayes/bin/mindtouch.deki.dll

You can pass it any dll containing a dream service. edited 20:33, 13 May 2008

Posted 20:30, 13 May 2008