Skip to content

Commit

Permalink
Doc: Fixes laurent22#2187: Fixed API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
laurent22 committed Dec 18, 2019
1 parent 74fd9e1 commit 797b71d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 17 deletions.
7 changes: 4 additions & 3 deletions CliClient/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 2 additions & 2 deletions ReactNativeClient/lib/WebDavApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
16 changes: 4 additions & 12 deletions readme/api.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -232,6 +222,7 @@ encryption_cipher_text | text |
encryption_applied | int |
encryption_blob_encrypted | int |
size | int |
is_shared | int |

## GET /resources

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 797b71d

Please sign in to comment.