self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-01-23 18:53:36 +02:00
Code Issues Releases Activity

Doc: Fixes #2187: Fixed API doc

Browse Source
This commit is contained in:
Laurent Cozic 2019-12-18 11:00:52 +00:00
parent 74fd9e1e9e
commit 797b71d903
3 changed files with 10 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CliClient/build.sh
View File

@ -8,8 +8,9 @@ rsync -a --delete "$ROOT_DIR/../ReactNativeClient/lib/" "$BUILD_DIR/lib/"
rsync -a --delete "$ROOT_DIR/../ReactNativeClient/locales/" "$BUILD_DIR/locales/"
cp "$ROOT_DIR/package.json" "$BUILD_DIR"
cd $ROOT_DIR/..
npm run tsc
cd $ROOT_DIR
# Don't add TypeScript here or make it silent as output of Cli app must be clean
# cd $ROOT_DIR/..
# npm run tsc
# cd $ROOT_DIR
chmod 755 "$BUILD_DIR/main.js"

4
ReactNativeClient/lib/WebDavApi.js
View File

@ -364,8 +364,8 @@ class WebDavApi {
let response = null;
// console.info('WebDAV Call', method + ' ' + url, headers, options);
// console.info(this.requestToCurl_(url, fetchOptions));
console.info('WebDAV Call', `${method} ${url}`, headers, options);
console.info(this.requestToCurl_(url, fetchOptions));
if (options.source == 'file' && (method == 'POST' || method == 'PUT')) {
if (fetchOptions.path) {

16
readme/api.md
View File

@ -1,15 +1,3 @@
> joplin@1.0.0 tsc /Users/laurent/src/joplin
> tsc
TSFILE: /Users/laurent/src/joplin/ReactNativeClient/lib/JoplinServerApi.js
TSFILE: /Users/laurent/src/joplin/ReactNativeClient/lib/JoplinServerApi.js.map
TSFILE: /Users/laurent/src/joplin/ElectronClient/app/lib/JoplinServerApi.js
TSFILE: /Users/laurent/src/joplin/ElectronClient/app/lib/JoplinServerApi.js.map
TSFILE: /Users/laurent/src/joplin/ElectronClient/app/gui/ShareNoteDialog.js
TSFILE: /Users/laurent/src/joplin/ElectronClient/app/gui/ShareNoteDialog.js.map
TSFILE: /Users/laurent/src/joplin/CliClient/build/lib/JoplinServerApi.js
TSFILE: /Users/laurent/src/joplin/CliClient/build/lib/JoplinServerApi.js.map
# Joplin API
When the Web Clipper service is enabled, Joplin exposes a [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer) which allows third-party applications to access Joplin's data and to create, modify or delete notes, notebooks, resources or tags.
@ -114,6 +102,7 @@ user_updated_time | int | When the note was last updated. It may differ from upd
encryption_cipher_text | text |
encryption_applied | int |
markup_language | int |
is_shared | int |
body_html | text | Note body, in HTML format
base_url | text | If `body_html` is provided and contains relative URLs, provide the `base_url` parameter too so that all the URLs can be converted to absolute ones. The base URL is basically where the HTML was fetched from, minus the query (everything after the '?'). For example if the original page was `https://stackoverflow.com/search?q=%5Bjava%5D+test`, the base URL is `https://stackoverflow.com/search`.
image_data_url | text | An image to attach to the note, in [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) format.
@ -186,6 +175,7 @@ user_updated_time | int | When the folder was last updated. It may differ from u
encryption_cipher_text | text |
encryption_applied | int |
parent_id | text |
is_shared | int |
## GET /folders
@ -232,6 +222,7 @@ encryption_cipher_text | text |
encryption_applied | int |
encryption_blob_encrypted | int |
size | int |
is_shared | int |
## GET /resources
@ -277,6 +268,7 @@ user_created_time | int | When the tag was created. It may differ from created_t
user_updated_time | int | When the tag was last updated. It may differ from updated_time as it can be manually set by the user.
encryption_cipher_text | text |
encryption_applied | int |
is_shared | int |
## GET /tags