2020-05-24 15:00:16 -04:00
openapi : 3.0 .3
2022-01-23 16:02:58 -05:00
info :
title : CodiMD
description : CodiMD is an open source collaborative note editor. Several tasks of CodiMD can be automated through this API.
2020-05-24 15:00:16 -04:00
version : 2.0 .0
2022-01-23 16:02:58 -05:00
contact :
name : CodiMD on GitHub
url : https://github.com/codimd/server
license :
name : AGPLv3
url : https://github.com/codimd/server/blob/master/LICENSE
externalDocs :
2020-06-06 17:26:48 -04:00
description : The CodiMD Documentation.
2020-05-24 15:00:16 -04:00
url : https://github.com/codimd/server/tree/master/docs
servers :
2020-06-06 17:26:48 -04:00
- url : "/api/v2"
description : The base API Path.
2022-01-23 16:02:58 -05:00
paths :
2020-05-24 15:00:16 -04:00
/auth/email :
post :
tags :
- auth
summary : Trying to login via email
operationId : loginEmail
requestBody :
required : true
content :
application/json :
schema :
$ref : '#/components/schemas/EmailLogin'
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The login was succesful.
2020-05-27 05:30:32 -04:00
headers :
Set-Cookie :
schema :
type : string
/auth/ldap :
post :
tags :
- auth
summary : Trying to login via LDAP
operationId : loginLdap
requestBody :
required : true
content :
application/json :
schema :
$ref : '#/components/schemas/LdapLogin'
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The login was succesful.
2020-05-27 05:30:32 -04:00
headers :
Set-Cookie :
schema :
type : string
/auth/openid :
post :
tags :
- auth
summary : Trying to login via OpenID
operationId : loginOpenId
requestBody :
required : true
content :
application/json :
schema :
$ref : '#/components/schemas/OpenIdLogin'
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The login was succesful.
2020-05-27 05:30:32 -04:00
headers :
Set-Cookie :
schema :
type : string
2020-07-09 20:29:44 -04:00
/auth/register :
post :
tags :
- auth
summary : Trying to register a new user via email
operationId : registerEmail
requestBody :
required : true
content :
application/json :
schema :
$ref : '#/components/schemas/EmailLogin'
responses :
'200' :
description : The user was successfully registered and logged-in afterwards.
headers :
Set-Cookies :
schema :
type : string
'409' :
description : There is already a user account with the given email address.
2020-05-24 15:00:16 -04:00
/me :
get :
tags :
- user
2020-06-06 16:00:17 -04:00
summary : Get the user information of the currently logged-in user
2020-05-24 15:00:16 -04:00
operationId : getMe
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The user information.
2020-05-24 15:00:16 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/UserInfo"
2020-05-28 16:19:15 -04:00
'401' :
2020-06-06 17:26:48 -04:00
description : The user is not logged in.
2020-05-24 15:00:16 -04:00
content : {}
2020-06-06 17:33:09 -04:00
put :
2020-05-30 20:22:00 -04:00
tags :
- user
summary : Update information about the currently logged-in user
operationId : updateMe
responses :
'200' :
2020-06-06 17:26:48 -04:00
description : The user information was changed successfully.
2020-05-30 20:22:00 -04:00
requestBody :
required : true
2020-06-06 17:26:48 -04:00
description : The new user information.
2020-05-30 20:22:00 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/UserUpdate"
2020-05-29 11:27:52 -04:00
delete :
tags :
- user
2020-06-06 17:26:48 -04:00
summary : Deletes the currently logged-in user from the backend and removes all their notes
2020-05-29 11:27:52 -04:00
operationId : deleteMe
responses :
'200' :
2020-06-06 17:26:48 -04:00
description : The user was deleted successfully.
2020-05-24 15:00:16 -04:00
/me/export :
get :
tags :
- user
2020-06-06 15:43:06 -04:00
- export
2020-06-06 17:26:48 -04:00
summary : Exports a zip-archive with all notes of the currently logged-in user
2020-05-24 15:00:16 -04:00
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The zip-archive with all notes.
2020-05-29 11:27:52 -04:00
/me/password :
post :
tags :
- user
2020-06-06 17:31:05 -04:00
summary : Sets the new password of the currently logged-in user
2020-05-29 11:27:52 -04:00
requestBody :
required : true
2020-06-06 17:26:48 -04:00
description : The new password of the user.
2020-05-29 11:27:52 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/UserPasswordChange"
responses :
'200' :
2020-06-06 17:26:48 -04:00
description : The password was changed.
2020-06-06 16:51:13 -04:00
/me/history :
2020-05-24 15:00:16 -04:00
get :
tags :
2020-06-06 16:51:13 -04:00
- history
2020-06-06 17:26:48 -04:00
summary : Returns a list of the last viewed notes
2020-06-06 16:51:13 -04:00
operationId : getHistory
description : The list is returned as a JSON object with an array containing for each entry it's id, title, tags, last visit time and pinned status.
responses :
'200' :
2020-06-06 17:26:48 -04:00
description : The list of recently viewed notes and pinned notes.
2020-06-06 16:51:13 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/History"
post :
tags :
- history
summary : Sets the history if none is already set
operationId : updateHistory
requestBody :
2020-06-06 17:26:48 -04:00
description : The history to update.
2020-06-06 16:51:13 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/History"
2020-05-24 15:00:16 -04:00
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The new history.
2020-05-24 15:00:16 -04:00
content :
application/json :
schema :
2020-06-06 16:51:13 -04:00
"$ref": "#/components/schemas/History"
delete :
tags :
- history
summary : Clear the currently logged-in users history
operationId : deleteHistory
responses :
'200' :
2020-06-06 17:26:48 -04:00
description : Deleted the history.
2020-06-06 16:51:13 -04:00
content : {}
/me/history/{note}:
put :
tags :
- history
summary : Update the history object of the note (e.g change it's pin status)
operationId : updateHistoryObject
requestBody :
2020-06-06 17:26:48 -04:00
description : The updated history object.
2020-06-06 16:51:13 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/HistoryObject"
responses :
'200' :
2020-06-06 17:26:48 -04:00
description : The new history.
2020-06-06 16:51:13 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/HistoryObject"
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the revision should be shown.
2020-06-06 16:51:13 -04:00
content :
text/plain :
example : my-note
delete :
tags :
- history
summary : Remove the note from the currently logged-in user's history
operationId : deleteHistoryObject
responses :
'200' :
2020-06-06 17:26:48 -04:00
description : The new history.
2020-06-06 16:51:13 -04:00
content : {}
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the revision should be shown.
2020-06-06 16:51:13 -04:00
content :
text/plain :
example : my-note
2020-05-27 07:20:37 -04:00
/notes :
2022-01-23 16:02:58 -05:00
post :
tags :
- note
2020-06-06 17:26:48 -04:00
summary : Imports some markdown data into a new note
2020-05-24 15:00:16 -04:00
operationId : createNoteFromMarkdown
2022-01-23 16:02:58 -05:00
description : A random id will be assigned and the content will equal to the body of the received HTTP-request.
requestBody :
2020-05-27 05:30:32 -04:00
required : false
2020-06-06 17:26:48 -04:00
description : The content of the note to be imported as markdown.
2022-01-23 16:02:58 -05:00
content :
'text/markdown' :
2020-05-24 15:00:16 -04:00
schema :
type : string
examples :
markdownExample :
"$ref": '#/components/examples/markdownExample'
2022-01-23 16:02:58 -05:00
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : Get information about the newly created note.
2020-05-24 15:00:16 -04:00
content :
application/json :
schema :
2020-05-27 07:25:37 -04:00
"$ref": "#/components/schemas/Note"
2020-05-27 07:20:37 -04:00
/notes/{note}:
2020-05-27 05:30:32 -04:00
get :
tags :
- note
2020-06-06 17:26:48 -04:00
summary : Returns the note
2020-05-27 05:30:32 -04:00
operationId : getNote
description : This includes all metadata and the content of the note.
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : All data of the note.
2020-05-27 05:30:32 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/Note"
2020-05-28 16:19:15 -04:00
'404' :
2020-06-06 17:26:48 -04:00
description : Note does not exist.
2020-05-27 05:30:32 -04:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the info should be shown.
2020-05-27 05:30:32 -04:00
content :
text/plain :
example : my-note
2022-01-23 16:02:58 -05:00
post :
tags :
- note
2020-06-06 17:26:48 -04:00
summary : Imports some markdown data into a new note with a given alias
2020-05-24 15:00:16 -04:00
operationId : createNoteWithAlias
2020-06-06 17:26:48 -04:00
description : This endpoint equals to the above one except that the alias from the url will be assigned to the note if [FreeURL-mode](https://github.com/codimd/server/tree/master/docs/configuration-env-vars.md#users-and-privileges) is enabled.
2022-01-23 16:02:58 -05:00
requestBody :
required : true
2020-06-06 17:26:48 -04:00
description : The content of the note to be imported as markdown.
2022-01-23 16:02:58 -05:00
content :
'text/markdown' :
2020-05-24 15:00:16 -04:00
schema :
type : string
examples :
markdownExample :
"$ref": '#/components/examples/markdownExample'
2022-01-23 16:02:58 -05:00
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : Get information about the newly created note.
2020-05-24 15:00:16 -04:00
content :
application/json :
schema :
2020-05-27 07:25:37 -04:00
"$ref": "#/components/schemas/Note"
2020-05-28 16:19:15 -04:00
'409' :
2020-06-06 17:26:48 -04:00
description : This alias is already in use.
2020-05-25 06:04:29 -04:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the info should be shown.
2020-05-25 06:04:29 -04:00
content :
text/plain :
example : my-note
2020-05-27 07:20:37 -04:00
/notes/{note}/permissions:
put :
tags :
- note
summary : Set the permissions of a note
operationId : updateNotePermissions
requestBody :
required : true
content :
application/json :
schema :
"$ref": "#/components/schemas/NotePermissions"
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The updated permissions of the note.
2020-05-27 07:20:37 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/NotePermissions"
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the info should be shown.
2020-05-27 07:20:37 -04:00
content :
text/plain :
example : my-note
get :
tags :
- note
summary : Get the permissions of a note
operationId : getNotePermissions
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The permissions of the note.
2020-05-27 07:20:37 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/NotePermissions"
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the info should be shown.
2020-05-27 07:20:37 -04:00
content :
text/plain :
example : my-note
/notes/{note}/export/markdown:
2020-05-25 06:04:29 -04:00
get :
tags :
- note
- export
2020-06-06 17:26:48 -04:00
summary : Returns the raw markdown content of a note
2020-05-24 15:00:16 -04:00
operationId : getNoteContent
2020-05-25 06:04:29 -04:00
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The raw markdown content of the note.
2020-05-25 06:04:29 -04:00
content :
'text/markdown' :
schema :
type : string
2020-05-27 05:30:32 -04:00
format : binary
2020-05-28 16:19:15 -04:00
'404' :
2020-06-06 17:26:48 -04:00
description : Note does not exist.
2020-05-25 06:04:29 -04:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the markdown should be exported.
2020-05-25 06:04:29 -04:00
content :
text/plain :
example : my-note
2020-05-27 07:20:37 -04:00
/notes/{note}/export/html:
2020-05-25 06:04:29 -04:00
get :
tags :
- note
- export
2020-06-06 17:26:48 -04:00
summary : Returns the content of a note as HTML
2020-05-25 06:04:29 -04:00
operationId : getNoteContentAsHTML
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The raw html content of the note.
2020-05-25 06:04:29 -04:00
content :
2020-05-27 05:30:32 -04:00
'text/html' :
2020-05-25 06:04:29 -04:00
schema :
type : string
2020-05-27 05:30:32 -04:00
format : binary
2020-05-28 16:19:15 -04:00
'404' :
2020-06-06 17:26:48 -04:00
description : Note does not exist.
2020-05-25 06:04:29 -04:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the html should be exported.
2020-05-25 06:04:29 -04:00
content :
text/plain :
example : my-note
2020-05-27 07:20:37 -04:00
/notes/{note}/export/gist:
2020-05-25 06:04:29 -04:00
get :
tags :
- note
- export
2020-06-06 17:26:48 -04:00
summary : Exports the content of a note to a gist
2020-05-25 06:04:29 -04:00
operationId : exportNoteToGist
2022-01-23 16:02:58 -05:00
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The link to Gist of the note.
2022-01-23 16:02:58 -05:00
content :
2020-05-27 05:30:32 -04:00
application/json :
2020-05-24 15:00:16 -04:00
schema :
2020-05-27 05:30:32 -04:00
"$ref": '#/components/schemas/GistLink'
2020-05-28 16:19:15 -04:00
'404' :
2020-06-06 17:26:48 -04:00
description : Note does not exist.
2022-01-23 16:02:58 -05:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note which should be exported to gist.
2022-01-23 16:02:58 -05:00
content :
2020-05-24 15:00:16 -04:00
text/plain :
2022-01-23 16:02:58 -05:00
example : my-note
2020-05-27 07:20:37 -04:00
/notes/{note}/export/dropbox:
2020-05-25 06:04:29 -04:00
get :
tags :
- note
- export
2020-06-06 17:26:48 -04:00
summary : Exports the content of a note to dropbox
2020-05-25 06:04:29 -04:00
operationId : exportNoteToDropbox
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The dropbox link of the note.
2020-05-25 06:04:29 -04:00
content :
2020-05-27 05:30:32 -04:00
application/json :
2020-05-25 06:04:29 -04:00
schema :
2020-05-27 05:30:32 -04:00
"$ref": '#/components/schemas/DropboxLink'
2020-05-28 16:19:15 -04:00
'404' :
2020-06-06 17:26:48 -04:00
description : Note does not exist.
2020-05-25 06:04:29 -04:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note which should be exported to dropbox.
2020-05-25 06:04:29 -04:00
content :
text/plain :
example : my-note
2020-05-27 07:20:37 -04:00
/notes/{note}/export/pdf:
2022-01-23 16:02:58 -05:00
get :
tags :
- note
2020-05-27 05:30:32 -04:00
- export
2020-06-06 17:26:48 -04:00
summary : Exports the content of a note as PDF
2020-05-27 05:30:32 -04:00
operationId : exportNoteToPDF
2022-01-23 16:02:58 -05:00
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The note as an PDF.
2022-01-23 16:02:58 -05:00
content :
2020-05-27 05:30:32 -04:00
application/pdf :
2022-01-23 16:02:58 -05:00
schema :
2020-05-27 05:30:32 -04:00
type : string
format : binary
2020-05-28 16:19:15 -04:00
'404' :
2020-06-06 17:26:48 -04:00
description : Note does not exist.
2022-01-23 16:02:58 -05:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note which should be exported to dropbox.
2022-01-23 16:02:58 -05:00
content :
2020-05-24 15:00:16 -04:00
text/plain :
2022-01-23 16:02:58 -05:00
example : my-note
2020-06-06 15:45:27 -04:00
/notes/{note}/revisions:
2022-01-23 16:02:58 -05:00
get :
tags :
- note
2020-06-06 17:26:48 -04:00
summary : Returns a list of the available note revisions
2020-05-24 15:00:16 -04:00
operationId : getAllRevisionsOfNote
2022-01-23 16:02:58 -05:00
description : 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.
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : Revisions of the note.
2022-01-23 16:02:58 -05:00
content :
2020-05-24 15:00:16 -04:00
application/json :
2022-01-23 16:02:58 -05:00
schema :
2020-05-24 15:00:16 -04:00
"$ref": "#/components/schemas/NoteRevisionsMetadata"
2020-05-28 16:19:15 -04:00
'404' :
2020-06-06 17:26:48 -04:00
description : Note does not exist.
2022-01-23 16:02:58 -05:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which revisions should be shown.
2022-01-23 16:02:58 -05:00
content :
2020-05-24 15:00:16 -04:00
text/plain :
2022-01-23 16:02:58 -05:00
example : my-note
2020-06-06 15:45:27 -04:00
/notes/{note}/revisions/{revision-id}:
2022-01-23 16:02:58 -05:00
get :
tags :
- note
2020-06-06 17:26:48 -04:00
summary : Returns the revision of the note with some metadata
2020-05-24 15:00:16 -04:00
operationId : getSpecificRevisionOfNote
2022-01-23 16:02:58 -05:00
description : The revision is returned as a JSON object with the content of the note and the authorship.
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : Revision of the note for the given timestamp.
2022-01-23 16:02:58 -05:00
content :
2020-05-24 15:00:16 -04:00
application/json :
2022-01-23 16:02:58 -05:00
schema :
2020-05-24 15:00:16 -04:00
"$ref": "#/components/schemas/NoteRevision"
2020-05-28 16:19:15 -04:00
'404' :
2020-06-06 17:26:48 -04:00
description : Note does not exist.
2022-01-23 16:02:58 -05:00
parameters :
- name : note
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The note for which the revision should be shown.
2022-01-23 16:02:58 -05:00
content :
2020-05-24 15:00:16 -04:00
text/plain :
2022-01-23 16:02:58 -05:00
example : my-note
- name : revision-id
in : path
required : true
2020-06-06 17:26:48 -04:00
description : The id (timestamp) of the revision to fetch.
2022-01-23 16:02:58 -05:00
content :
2020-05-24 15:00:16 -04:00
text/plain :
2022-01-23 16:02:58 -05:00
example : 1570921051959
2020-07-09 20:29:44 -04:00
/media/proxy :
post :
tags :
- media
summary : Returns a proxied url for a given image url
description : Returns in exchange for an image-url the url for a proxied version of the image.
responses :
'200' :
description : An object containing the proxied url
content :
application/json :
schema :
"$ref": "#/components/schemas/ImageProxyResponse"
requestBody :
required : true
description : An object containing the original image url
content :
application/json :
schema :
"$ref": "#/components/schemas/ImageProxyRequest"
/media/upload :
post :
tags :
- media
summary : Uploads an image to the backend storage
description : Uploads an image to be processed by the backend.
requestBody :
required : true
description : The binary image to upload.
responses :
'200' :
description : The image was uploaded successfully.
2020-05-27 08:58:49 -04:00
/config :
get :
tags :
2020-06-06 17:33:54 -04:00
- backend
2020-05-27 08:58:49 -04:00
summary : The config of the backend
operationId : getConfig
responses :
2020-05-28 16:19:15 -04:00
'200' :
2020-06-06 17:26:48 -04:00
description : The config of the backend in JSON.
2020-05-27 08:58:49 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/Config"
2020-06-06 16:51:39 -04:00
/status :
get :
tags :
2020-06-06 17:33:54 -04:00
- backend
2020-06-06 17:26:48 -04:00
summary : Returns the current status of the backend
2020-06-06 16:51:39 -04:00
operationId : getStatus
description : The data is returned as a JSON object containing the number of notes stored on the server, (distinct) online users and more.
responses :
'200' :
2020-06-06 17:26:48 -04:00
description : The server info.
2020-06-06 16:51:39 -04:00
content :
application/json :
schema :
"$ref": "#/components/schemas/ServerStatus"
2020-05-24 15:00:16 -04:00
components :
schemas :
UserInfo :
type : object
properties :
id :
type : string
format : UUIDv4
name :
type : string
photo :
type : string
format : uri
2020-05-29 11:27:52 -04:00
provider :
type : string
enum : [ 'facebook' , 'github' , 'twitter' , 'gitlab' , 'dropbox' , 'google' , 'saml' , 'oauth2' , 'email' , 'ldap' , 'openid' ]
UserPasswordChange :
type : object
properties :
password :
type : string
2020-05-30 20:22:00 -04:00
UserUpdate :
type : object
properties :
name :
type : string
2020-06-06 17:26:48 -04:00
description : The new display name of the user.
2020-07-09 20:29:44 -04:00
ImageProxyRequest :
type : object
properties :
src :
type : string
description : The url of the image that should be processed by the image proxy.
ImageProxyResponse :
type : object
properties :
src :
type : string
description : The url of the provied version of the image.
2020-05-27 08:58:49 -04:00
Config :
type : object
properties :
allowAnonymous :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether anonymous notes are allowed.
2020-05-27 08:58:49 -04:00
authProviders :
type : object
properties :
facebook :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether Facebook login is possible.
2020-05-27 08:58:49 -04:00
github :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether GitHub login is possible.
2020-05-27 08:58:49 -04:00
twitter :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether Twitter login is possible.
2020-05-27 08:58:49 -04:00
gitlab :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether Gitlab login is possible.
2020-05-27 08:58:49 -04:00
dropbox :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether Dropbox login is possible.
2020-05-27 08:58:49 -04:00
google :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether Google login is possible.
2020-05-27 08:58:49 -04:00
saml :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether SAML login is possible.
2020-05-27 08:58:49 -04:00
oauth2 :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether OAuth2 login is possible.
2020-05-27 08:58:49 -04:00
email :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether E-Mail login is possible.
2020-05-27 08:58:49 -04:00
ldap :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether LDAP login is possible.
2020-05-27 08:58:49 -04:00
openid :
type : boolean
2020-06-06 17:26:48 -04:00
description : Wether OpenID login is possible.
2020-05-27 08:58:49 -04:00
customAuthNames :
type : object
properties :
ldap :
type : string
2020-06-06 17:26:48 -04:00
description : The custom name for the LDAP Login.
2020-05-27 08:58:49 -04:00
example : "FooBar LDAP"
oauth2 :
type : string
2020-06-06 17:26:48 -04:00
description : The custom name for the OAuth2 Login.
2020-05-27 08:58:49 -04:00
example : "Olaf2"
saml :
type : string
2020-06-06 17:26:48 -04:00
description : The custom name for the SAML Login.
2020-05-27 08:58:49 -04:00
example : "aufSAMLn.de"
specialLinks :
type : object
properties :
privacy :
type : string
format : uri
2020-06-06 17:26:48 -04:00
description : Link to the privacy notice.
2020-05-27 08:58:49 -04:00
termsOfUse :
type : string
format : uri
2020-06-06 17:26:48 -04:00
description : Link to the terms of use.
2020-05-27 08:58:49 -04:00
imprint :
type : string
format : uri
2020-06-06 17:26:48 -04:00
description : Link to the imprint.
2020-05-28 16:19:33 -04:00
version :
type : object
properties :
version :
type : string
sourceCodeUrl :
type : string
format : uri
issueTrackerUrl :
type : string
format : uri
2020-05-25 06:04:29 -04:00
Note :
type : object
properties :
id :
type : string
format : UUIDv4
2020-06-06 17:26:48 -04:00
description : The id of the note.
2020-05-25 06:04:29 -04:00
alias :
type : string
2020-06-06 17:26:48 -04:00
description : The alias of the note.
2020-05-25 06:04:29 -04:00
lastChange :
type : object
properties :
userId :
type : string
format : UUIDv4
2020-06-06 17:26:48 -04:00
description : The id of the user that last changed the note.
2020-05-25 06:04:29 -04:00
user :
type : string
2020-06-06 17:26:48 -04:00
description : The name of the user that last changed the note.
2020-05-25 06:04:29 -04:00
timestamp :
type : integer
description : UNIX-timestamp of when the note was last changed.
2020-05-27 05:30:32 -04:00
viewcount :
type : integer
minimum : 0
2020-06-06 17:26:48 -04:00
description : How often the published version of the note was viewed.
2020-05-27 05:30:32 -04:00
createtime :
type : string
description : The timestamp when the note was created in ISO 8601 format.
2020-05-25 06:04:29 -04:00
content :
type : string
2020-06-06 17:26:48 -04:00
description : The raw markdown content of the note revision.
2020-05-25 06:04:29 -04:00
authorship :
type : array
2020-06-06 17:26:48 -04:00
description : Data which gives insights about who worked on the note.
2020-05-25 06:04:29 -04:00
items :
type : integer
2020-06-06 17:26:48 -04:00
description : Unique user ids and additional data.
2020-05-27 07:20:37 -04:00
NotePermissions :
type : object
properties :
permission :
type : string
enum : [ 'freely' , 'editable' , 'limited' , 'locked' , 'protected' , 'private' ]
2020-05-24 15:00:16 -04:00
NoteRevisionsMetadata :
type : object
properties :
revision :
type : array
2020-06-06 17:26:48 -04:00
description : Array that holds all revision-info objects.
2020-05-24 15:00:16 -04:00
items :
type : object
properties :
time :
type : integer
description : UNIX-timestamp of when the revision was saved. Is also the revision-id.
length :
type : integer
2020-06-06 17:26:48 -04:00
description : Length of the document to the timepoint the revision was saved.
2020-05-24 15:00:16 -04:00
NoteRevision :
type : object
properties :
2022-01-23 16:02:58 -05:00
content :
2020-05-24 15:00:16 -04:00
type : string
2020-06-06 17:26:48 -04:00
description : The raw markdown content of the note revision.
2020-05-24 15:00:16 -04:00
authorship :
type : array
2020-06-06 17:26:48 -04:00
description : Data which gives insights about who worked on the note.
2020-05-24 15:00:16 -04:00
items :
type : integer
2020-06-06 17:26:48 -04:00
description : Unique user ids and additional data.
2020-05-24 15:00:16 -04:00
patch :
type : array
2020-06-06 17:26:48 -04:00
description : Data which gives insight about what changed in comparison to former revisions.
2020-05-24 15:00:16 -04:00
items :
type : string
2020-05-27 05:30:32 -04:00
GistLink :
2020-05-24 15:00:16 -04:00
type : object
properties :
2020-05-27 05:30:32 -04:00
link :
2020-05-24 15:00:16 -04:00
type : string
2020-05-27 05:30:32 -04:00
format : uri
2020-06-06 17:26:48 -04:00
description : A Gist link.
2020-05-27 05:30:32 -04:00
DropboxLink :
type : object
properties :
link :
2020-05-24 15:00:16 -04:00
type : string
2020-05-27 05:30:32 -04:00
format : uri
2020-06-06 17:26:48 -04:00
description : A Dropbox link.
2020-05-24 15:00:16 -04:00
EmailLogin :
type : object
properties :
email :
type : string
format : email
password :
type : string
format : password
2020-05-27 05:30:32 -04:00
LdapLogin :
type : object
properties :
username :
type : string
format : email
password :
type : string
format : password
OpenIdLogin :
type : object
properties :
openId :
type : string
2020-05-24 15:00:16 -04:00
ServerStatus :
type : object
properties :
onlineNotes :
type : integer
2020-06-06 17:26:48 -04:00
description : How many notes are edited at the moment.
2020-05-24 15:00:16 -04:00
onlineUsers :
type : integer
2020-06-06 17:26:48 -04:00
description : How many users are online at the moment.
2020-05-24 15:00:16 -04:00
distinctOnlineUsers :
type : integer
2020-06-06 17:26:48 -04:00
description : How many distinct users (different machines) are online at the moment.
2020-05-24 15:00:16 -04:00
notesCount :
type : integer
2020-06-06 17:26:48 -04:00
description : How many notes are stored on the server.
2020-05-24 15:00:16 -04:00
registeredUsers :
type : integer
2020-06-06 17:26:48 -04:00
description : How many users are registered on the server.
2020-05-24 15:00:16 -04:00
onlineRegisteredUsers :
type : integer
2020-06-06 17:26:48 -04:00
description : How many of the online users are registered on the server.
2020-05-24 15:00:16 -04:00
distinctOnlineRegisteredUsers :
type : integer
2020-06-06 17:26:48 -04:00
description : How many of the distinct online users are registered on the server.
2020-05-24 15:00:16 -04:00
isConnectionBusy :
type : boolean
connectionSocketQueueLength :
type : integer
isDisconnectBusy :
type : boolean
disconnectSocketQueueLength :
type : integer
2020-05-27 08:34:25 -04:00
HistoryObject :
type : object
properties :
id :
type : string
2020-06-06 17:26:48 -04:00
description : The id or alias of the note.
2020-05-27 08:34:25 -04:00
title :
type : string
2020-06-06 17:26:48 -04:00
description : The title of the note.
2020-05-27 08:34:25 -04:00
lastVisited :
type : integer
2020-06-06 17:26:48 -04:00
description : The UNIX-timestamp in milliseconds when the note was last accessed by the user.
2020-05-27 08:34:25 -04:00
tags :
type : array
2020-06-06 17:26:48 -04:00
description : The tags that were added by the user to the note.
2020-05-27 08:34:25 -04:00
items :
type : string
pinned :
type : boolean
2020-06-06 17:26:48 -04:00
description : Whether the user has pinned this note.
2020-05-27 08:34:25 -04:00
History :
type : object
properties :
history :
type : array
2020-06-06 17:26:48 -04:00
description : The array that contains history objects.
2020-05-27 08:34:25 -04:00
items :
"$ref": "#/components/schemas/HistoryObject"
2020-05-24 15:00:16 -04:00
examples :
markdownExample :
value : '# Some header\nSome normal text. **Some bold text**'
summary : A sample markdown content