fix documentation for http routes

AutomaticBackups.js

@@ -21,7 +21,6 @@ exports.startup = function () {
   if($tw.node) {
     $tw.ServerSide = $tw.ServerSide || require('$:/plugins/OokTech/Bob/ServerSide.js');
     // Make sure that $tw.settings is available.
-    //const settings = require('$:/plugins/OokTech/NodeSettings/NodeSettings.js')
     // require the fs module if we are running node
     const fs = require("fs");
     const path = require("path");

Documentation/HTTPAPI/get-list-files.tid → Documentation/HTTPAPI/get-files-list.tid

@@ -1,18 +1,18 @@
 title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/get-list-files
 tags: [[HTTP API]]
 verb: GET
-route: /api/list/files /api/list/files/path/:prefix /api/list/files/wiki/:wikiname
-response: JSON object with a list of globally available files
+route: /api/files/list /api/files/list/path/:prefix /api/files/list/wiki/:wikiname
+response: JSON object with a list of available files
 parameters:
 description: get a list of available files on the server
 
-Using the `/api/list/files/` path the list of files returned is from the folder
+Using the `/api/files/list/` path the list of files returned is from the folder
 listed as the `filePathRoot`.
 
-Using the `/api/list/files/path/:prefix` path returns the list of files served
+Using the `/api/files/list/path/:prefix` path returns the list of files served
 using the prefix `:prefix`.
 
-Using the `/api/list/files/wiki/:wikiname` path returns the files specific to
+Using the `/api/files/list/wiki/:wikiname` path returns the files specific to
 the wiki `:wikiname`. These files are in the `files` folder next to the
 `tiddlers` folder for the wiki.
 
@@ -32,6 +32,6 @@ appended to the front of the file name, like `/files/file1.png`.
 
 Example:
 
-* `/api/list/files`
-* `/api/list/files/path/foo`
-* `/api/list/files/wiki/someWiki`
+* `/api/files/list`
+* `/api/files/list/path/foo`
+* `/api/files/list/wiki/someWiki`

Documentation/HTTPAPI/get-fetch-plugin.tid → Documentation/HTTPAPI/get-plugins-fetch.tid

@@ -1,7 +1,7 @@
 title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/fetch-plugin
 tags: [[HTTP API]]
 verb: GET
-route: /api/fetch/plugins/:plugin
+route: /api/plugins/fetch/:plugin
 response: The plugin tiddler as JSON
 parameters:
 description: fetch a plugin from the server
@@ -14,4 +14,4 @@ The `:plugin` part of the path should be in the from `Author/PluginName`.
 
 Example:
 
-* `/api/fetch/plugins/OokTech/Bob`
+* `/api/plugins/fetch/OokTech/Bob`

Documentation/HTTPAPI/get-list-plugins.tid → Documentation/HTTPAPI/get-plugins-list.tid

@@ -1,7 +1,7 @@
-title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/get-list-plugins
+title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/get-plugins-list
 tags: [[HTTP API]]
 verb: GET
-route: /api/list/plugins
+route: /api/plugins/list
 response: An array of JSON objects that contain information about the available plugins
 parameters:
 description: get a list of available plugins
@@ -32,4 +32,4 @@ The retuned object is in the form:
 
 Example:
 
-* `/api/list/plugins`
+* `/api/plugins/list`

Documentation/HTTPAPI/get-fetch-tiddler-html.tid → Documentation/HTTPAPI/get-tiddlers-fetch-html.tid

@@ -1,13 +1,16 @@
 title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/get-fetch-tiddler-html
 tags: [[HTTP API]]
 verb: GET
-route: /api/fetch/tiddler/html
+route: /api/tiddlers/fetch/html/:wiki
 response: The rendered html of the requested tiddler
-parameters: `wiki` `tiddler`
+parameters: `tiddler`
 description: get the rendered html of a tiddler
 
+Note: Because of how Bob handles different wikis, this doesn't render the
+static css in the expected way.
+
 Get the rendered html version of a tiddler.
 
 Example:
 
-* `/api/fetch/tiddler/html?wiki=SomeWiki&tiddler=tiddlerTitle`
+* `/api/tiddlers/fetch/html/SomeWiki?tiddler=tiddlerTitle`

Documentation/HTTPAPI/get-fetch-list.tid → Documentation/HTTPAPI/get-tiddlers-fetch-list.tid

@@ -1,19 +1,18 @@
 title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/fetch-list
 tags: [[HTTP API]]
 verb: GET
-route: /api/fetch/list
+route: /api/tiddlers/fetch/list/:wikiname
 response: A JSON object containing a list of tiddler titles and optionally additional fields from the tiddlers
-parameters: `wiki` `filter` `fields`
+parameters: `filter` `fields`
 description: fetch a list of tiddler titles from a wiki using a filter
 
 Requests a list of tiddler titles selected using a filter evaluated in a named
 wiki.
 
 The url parameters are:
 
-* `wiki` is the name of the wiki to fetch titles from, it must be url encoded if it has spaces or `/` characters
 * `filter` is the filter to run in the target wiki
-* `fields` is a comma separated list of fields that are returned in the `info` part of the returned object. Defaults to `modified`
+* `fields` is an optional space separated list of fields to include in the info section of the returned data
 
 The returned JSON object has the form:
 
@@ -35,5 +34,5 @@ The returned JSON object has the form:
 
 Examples:
 
-* `/api/fetch/list?wiki=SomeWiki&filter=[tag[foo]]`
-* `/api/fetch/list?wiki=SomeOtherWiki&filter=[tag[bar]]`
+* `/api/fetch/list/SomeWiki?filter=[tag[foo]]`
+* `/api/fetch/list/SomeOtherWiki?filter=[tag[bar]]&fields=modified tags`

Documentation/HTTPAPI/get-tiddlers-fetch.tid

@@ -0,0 +1,36 @@
+title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/get-fetch-tiddlers
+tags: [[HTTP API]]
+verb: GET
+route: /api/tiddlers/fetch/:wikiname
+response: Tiddlers in JSON format
+parameters: `filter` `tiddler`
+description: fetch tiddlers from the server
+
+Return a set of tiddlers using a filter, from the named wiki.
+
+
+Parameters:
+
+* `filter` the filter to evaluate in the wiki to select tiddlers to fetch
+* `fields` a space separated list of field names that get included in the `info` part of the returned data
+
+the returned json object has the form:
+
+```
+{
+  list: ["title1", "title2"],
+  tiddlers: {
+    title1: {\* tiddler fields *\},
+    title2: {\* tiddler fields *\}
+  },
+  info: {
+    title1: {\* fields listed in the fields paramater *\},
+    title2: {\* fields listed in the fields paramater *\}
+  }
+}
+```
+
+Examples:
+
+* `/api/fetch?wiki=someWiki&filter=[tag[foo]]`
+* `/api/fetch?wiki=someWiki&filter=[tag[foo]]&fields=foo bar`

Documentation/HTTPAPI/get-list-wikis.tid → Documentation/HTTPAPI/get-wikis-list.tid

@@ -1,7 +1,7 @@
 title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/get-list-wikis
 tags: [[HTTP API]]
 verb: GET
-route: /api/list/wikis
+route: /api/wikis/list
 response: A JSON object containing a list of available wikis
 parameters:
 description: get a list of available wikis

Documentation/HTTPAPI/post-delete-tiddler.tid → Documentation/HTTPAPI/post-tiddlers-delete.tid

@@ -1,7 +1,7 @@
 title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/delete-tiddler
 tags: [[HTTP API]]
 verb: POST
-route: /api/delete/tiddler/:wikiname
+route: /api/tiddlers/delete/:wikiname
 description: Delete one or more tiddlers from a wiki
 
 This is POST instead of DELETE because in general nothing but the url should

Documentation/HTTPAPI/post-push.tid → Documentation/HTTPAPI/post-tiddlers-push.tid

@@ -1,7 +1,7 @@
 title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/post-push
 tags: [[HTTP API]]
 verb: POST
-route: /api/push/:wikiname
+route: /api/tiddlers/push/:wikiname
 response:
 parameters:
 description: push tiddlers to a wiki

Documentation/HTTPAPI/post-delete-wiki.tid → Documentation/HTTPAPI/post-wiki-delete.tid

@@ -1,7 +1,7 @@
 title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/delete-wiki
 tags: [[HTTP API]]
 verb: POST
-route: /api/delete/wiki/:wikiname
+route: /api/wiki/delete/:wikiname
 description: Delete a wiki
 
 This deletes the wiki `:wikiname` given in the URL.

Documentation/HTTPAPI/post-wiki-rename.tid

@@ -0,0 +1,14 @@
+title: $:/plugins/OokTech/Bob/Documentation/HTTPAPI/post-wiki-rename
+tags: [[HTTP API]]
+verb: POST
+route: /api/wiki/rename/:wikiname
+response:
+parameters: newname
+description: rename a wiki
+
+This renames a wiki.
+
+`:wikiname` in the url is the wiki to rename, the `newname` parameter is the
+new name.
+
+Anything in the POST body will be ignored.

ServerRoutes/ServerRoutes/get-tiddlers-fetch-list.js

@@ -7,7 +7,7 @@ get /^\/api\/tiddlers\/fetch\/list\/<<wikiName>>\/?$/
 
 fetch a list of tiddlers returned by a filter
 
-params: ?wiki=wikiName&filter=<<someFilter>>&fields=tags
+params: ?filter=<<someFilter>>
 
 \*/
 (function() {