self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-12-17 23:27:48 +02:00
Code Issues Releases Activity

Update API doc

Browse Source
This commit is contained in:
Laurent Cozic
2018-11-08 01:17:46 +00:00
parent 5ff8808f69
commit 2bcddd38b2
3 changed files with 55 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CliClient/app/command-apidoc.js
View File

@@ -69,7 +69,8 @@ class Command extends BaseCommand {
lines.push(' }');
lines.push('}');
lines.push('```');
lines.push('');
lines.push('# Authorisation')
lines.push('');
lines.push('To prevent unauthorised applications from accessing the API, the calls must be authentified. To do so, you must provide a token as a query parameter for each API call. You can get this token from the Joplin desktop application, on the Web Clipper Options screen.');
@@ -79,6 +80,7 @@ class Command extends BaseCommand {
lines.push('\tcurl http://localhost:41184/notes?token=ABCD123ABCD123ABCD123ABCD123ABCD123');
lines.push('');
lines.push('In the documentation below, the token will not be specified every time however you will need to include it.');
lines.push('');
lines.push('# Using the API');
lines.push('');