Resources
| Wiki Markup |
|---|
{html}http://localhost:8080/{html} |
Request Type | Response / Action | Status Code |
|---|---|---|
GET | Redirects to the start page for the Decapod user interface. | Success: 301 |
| Wiki Markup |
|---|
{html}http://localhost:8080/library/{html} |
The set of all "Books" in Decapod.
Request Type | Response / Action | Status Code |
|---|---|---|
GET, DELETE, POST, PUT | N/A | Error: 405 |
...
The information about a specific "Book".
Request Type | Response / Action | Status Code |
|---|---|---|
DELETE | Removes a book and all its attached pages | Success: 204 |
GET, POST, PUT | N/A | Error: 405 |
...
The set of "pages" contained within a "book".
Request Type | Response / Action | Status Code |
|---|---|---|
POST | Creates a new page and returns the URL | Success: 201 |
GET, DELETE, PUT | N/A | Error: 405 |
| Wiki Markup |
|---|
{html}http://localhost:8080/library/'bookName'/export/...{html} |
This will be a base url that has the parameters for the type of export appended as segments afterwards.
e.g. Wiki Markup
Request Type | Response / Action | Status Code | |||||||
|---|---|---|---|---|---|---|---|---|---|
GET | Returns the status of the export and a link to the artifact if complete, in JSON format.
| Success: 200 | |||||||
PUT | Trigger the creation of the export artifact. | Success: 202 | |||||||
DELETE | Removes the export artifact | Success: 204 | |||||||
POST | N/A | Error: 405 |