DRAFT
This information is preliminary and not yet (or only partially) implemented. Do not rely on any information presented here until this notice is removed.
TiddlyWeb, beyond being a reference "mother of all server-sides" for TiddlyWiki, is concept for providing standardized communication between TiddlyWiki clients and servers. WikklyText implements the TiddlyWeb API. This allows clients to communicate with the TiddlyWeb server through a
RESTful API.
Background:
The REST API is provided through the following URLs:
- API_ROOT/bags
- API.TiddlyWeb.Resource.Bags
- API_ROOT/bags/BAGNAME
- TBD
- API_ROOT/bags/BAGNAME/tiddlers
- API.TiddlyWeb.Resource.Bags.Tiddlers
- API_ROOT/bags/BAGNAME/tiddlers/NAME
- TBD
- API_ROOT/bags/BAGNAME/tiddlers/NAME/revisions/REVISION
- TBD
- API_ROOT/recipes
- API.TiddlyWeb.Resource.Recipes
- API_ROOT/recipes/RECIPE
- API.TiddlyWeb.Resource.Recipes.Rules
- API_ROOT/recipes/RECIPENAME/tiddlers
- API.TiddlyWeb.Resource.Recipes.Tiddlers
- API_ROOT/recipes/RECIPE/tiddlers/NAME
- TBD
- API_ROOT/recipes/RECIPE/tiddlers/NAME/revisions/REVISION
- TBD
Here,
API_ROOT means the root of the TiddlyWeb API on a particular server. For example, if the TiddlyWeb resource
/bags is found at:
http://server.com/api/bags
... then
API_ROOT is:
http://server.com/api