summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/api.md1
-rw-r--r--docs/dev/openapi.yml23
2 files changed, 0 insertions, 24 deletions
diff --git a/docs/dev/api.md b/docs/dev/api.md
index 5422533d..e89741d3 100644
--- a/docs/dev/api.md
+++ b/docs/dev/api.md
@@ -13,7 +13,6 @@ You have to replace *\<NOTE\>* with either the alias or id of a note you want to
| `/new` | `POST` | **Imports some markdown data into a new note.**<br>A random id will be assigned and the content will equal to the body of the received HTTP-request. The `Content-Type: text/markdown` header should be set on this request. |
| `/new/<ALIAS>` | `POST` | **Imports some markdown data into a new note with a given alias.**<br>This endpoint equals to the above one except that the alias from the url will be assigned to the note if [FreeURL-mode](../configuration-env-vars.md#users-and-privileges) is enabled. |
| `/<NOTE>/download` or `/s/<SHORT-ID>/download` | `GET` | **Returns the raw markdown content of a note.** |
-| `/<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. |
diff --git a/docs/dev/openapi.yml b/docs/dev/openapi.yml
index aafaddc3..77d7e9de 100644
--- a/docs/dev/openapi.yml
+++ b/docs/dev/openapi.yml
@@ -89,29 +89,6 @@ paths:
'text/plain':
example: my-note
- /{note}/pdf:
- get:
- tags:
- - note
- summary: Returns a generated pdf version of the note.
- description: '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._'
- responses:
- 200:
- description: The generated pdf version of the note
- content:
- 'application/pdf':
- example: binary
- 404:
- description: Note does not exist
- parameters:
- - name: note
- in: path
- required: true
- description: The note which should be exported as pdf
- content:
- 'text/plain':
- example: my-note
-
/{note}/publish:
get:
tags: