diff options
author | Erik Michelson | 2019-10-15 00:58:40 +0200 |
---|---|---|
committer | Erik Michelson | 2019-10-15 00:58:40 +0200 |
commit | 93ca037a759ea34c40ef069a78d29505d0ac300d (patch) | |
tree | 375447c78217ab610fc8b0ab69acedcc2c547adb /docs/dev/api.md | |
parent | 447d9bc1d80bc792129e80eb685d8d12670c6cf1 (diff) |
WIP: Adding openapi doc
Signed-off-by: Erik Michelson <erik@liltv.de>
Diffstat (limited to '')
-rw-r--r-- | docs/dev/api.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/dev/api.md b/docs/dev/api.md index 43bc9143..4c1365b5 100644 --- a/docs/dev/api.md +++ b/docs/dev/api.md @@ -16,7 +16,7 @@ You have to replace _\<NOTE\>_ with either the alias or id of a note you want to | `/<NOTE>/pdf` | `GET` | **Returns a generated pdf version of the note.**<br>If pdf-support is disabled, a HTTP 403 will be returned.<br>_Please note: Currently pdf export is disabled generally because of a security problem with it._ | | `/<NOTE>/publish` | `GET` | **Redirects to the published version of the note.** | | `/<NOTE>/slide` | `GET` | **Redirects to the slide-presentation of the note.**<br>This is only useful on notes which are designed to be slides. | -| `/<NOTE>/info` | `GET` | **Returns metadata about the note.**<br>This includes the title and description of the note as well as the creation date and viewcount.The data is returned as a JSON object. | +| `/<NOTE>/info` | `GET` | **Returns metadata about the note.**<br>This includes the title and description of the note as well as the creation date and viewcount. The data is returned as a JSON object. | | `/<NOTE>/revision` | `GET` | **Returns a list of the available note revisions.**<br>The list is returned as a JSON object with an array of revision-id and length associations. The revision-id equals to the timestamp when the revision was saved. | | `/<NOTE>/revision/<REVISION-ID>` | `GET` | **Returns the revision of the note with some metadata.**<br>The revision is returned as a JSON object with the content of the note and the authorship. | | `/<NOTE>/gist` | `GET` | **Creates a new GitHub Gist with the note's content.**<br>If [GitHub integration](../configuration-env-vars.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created. | |