diff --git a/docs/api/index.html b/docs/api/index.html index 2bdfa8353..3dd9ed69a 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -285,7 +285,9 @@ for (let portToTest = 41184; portToTest <= 41194; portToTest++) { 
curl http://localhost:41184/notes/ABCD123?fields=longitude,latitude

To get the IDs only of all the tags:

curl http://localhost:41184/tags?fields=id
-

About the property types

+

Error handling

+

In case of an error, an HTTP status code >= 400 will be returned along with a JSON object that provides more info about the error. The JSON object is in the format { "error": "description of error" }.

+

About the property types

Testing if the service is available

Call GET /ping to check if the service is available. It should return "JoplinClipperServer" if it works.

+

Searching

+

Call GET /search?query=YOUR_QUERY to search for notes. This end-point supports the field parameter which is recommended to use so that you only get the data that you need. The query syntax is as described in the main documentation: https://joplin.cozic.net/#searching

Notes

Properties

diff --git a/docs/index.html b/docs/index.html index dc7d6bb82..528614216 100644 --- a/docs/index.html +++ b/docs/index.html @@ -559,42 +559,42 @@ $$ - + - + - + - + - + - + @@ -608,7 +608,7 @@ $$ - + @@ -622,105 +622,105 @@ $$ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
Basque eu juan.abasolo@ehu.eus57%56%
Catalan ca jmontane, 201882%80%
Croatian hr_HR Hrvoje Mandić (trbuhom@net.hr)46%45%
Czech cs_CZ Lukas Helebrandt (lukas@aiya.cz)72%71%
Dansk da_DK Morten Juhl-Johansen Zölde-Fejér (mjjzf@syntaktisk.74%72%
Deutsch de_DE Michael Sonntag (ms@editorei.de)95%98%
Español es_ES Fernando Martín (f@mrtn.es)87%88%
Galician gl_ES Marcos Lans (marcoslansgarza@gmail.com)73%71%
Italiano it_IT 90%89%
Nederlands nl_BE 58%56%
Nederlands nl_NL Heimen Stoffels (vistausss@outlook.com)87%86%
Norwegian nb_NO Mats Estensen (code@mxe.no)95%94%
Português (Brasil) pt_BR Renato Nunes Bastos (rnbastos@gmail.com)94%93%
Română ro 57%56%
Slovenian sl_SI 72%70%
Svenska sv Jonatan Nyberg (jonatan@autistici.org)98%96%
Türkçe tr_TR Zorbey Doğangüneş (zorbeyd@gmail.com)83%93%
Русский ru_RU Artyom Karlov (artyom.karlov@gmail.com)88%98%
中文 (简体) zh_CN 99%97%
中文 (繁體) zh_TW penguinsam (samliu@gmail.com)87%86%
日本語 ja_JP AWASHIRO Ikuya (ikunya@gmail.com)94%93%
한국말 ko 96%95%
diff --git a/docs/stats/index.html b/docs/stats/index.html index 17bfa830a..baa4409ca 100644 --- a/docs/stats/index.html +++ b/docs/stats/index.html @@ -261,15 +261,15 @@ Total Windows downloads -180,491 +180,754 Total macOs downloads -86,259 +86,356 Total Linux downloads -66,897 +67,052 Windows % @@ -300,18 +300,18 @@ v1.0.127 2019-02-14T23:12:48Z -7,176 -2,560 -2,068 -11,804 +7,426 +2,655 +2,222 +12,303 v1.0.126 2019-02-09T19:46:16Z -785 +797 44 102 -931 +943 v1.0.125 @@ -364,10 +364,10 @@ v1.0.115 2018-11-16T16:52:02Z -3,625 +3,626 1,276 780 -5,681 +5,682 v1.0.114 @@ -541,9 +541,9 @@ v1.0.83 2018-04-04T19:43:58Z 4,509 -2,397 +2,399 2,627 -9,533 +9,535 v1.0.82 @@ -822,8 +822,8 @@ 2017-11-24T14:27:49Z 136 664 -5,207 -6,007 +5,208 +6,008 v0.10.23 diff --git a/readme/api.md b/readme/api.md index 164cc16de..e7d56d4e1 100644 --- a/readme/api.md +++ b/readme/api.md @@ -54,6 +54,10 @@ To get the IDs only of all the tags: curl http://localhost:41184/tags?fields=id +# Error handling + +In case of an error, an HTTP status code >= 400 will be returned along with a JSON object that provides more info about the error. The JSON object is in the format `{ "error": "description of error" }`. + # About the property types * Text is UTF-8. @@ -64,6 +68,10 @@ To get the IDs only of all the tags: Call **GET /ping** to check if the service is available. It should return "JoplinClipperServer" if it works. +# Searching + +Call **GET /search?query=YOUR_QUERY** to search for notes. This end-point supports the `field` parameter which is recommended to use so that you only get the data that you need. The query syntax is as described in the main documentation: https://joplin.cozic.net/#searching + # Notes ## Properties diff --git a/readme/stats.md b/readme/stats.md index 2dc26cf73..671e5a5d1 100644 --- a/readme/stats.md +++ b/readme/stats.md @@ -2,24 +2,24 @@ Name | Value --- | --- -Total Windows downloads | 180,491 -Total macOs downloads | 86,259 -Total Linux downloads | 66,897 +Total Windows downloads | 180,754 +Total macOs downloads | 86,356 +Total Linux downloads | 67,052 Windows % | 54% macOS % | 26% Linux % | 20% Version | Date | Windows | macOS | Linux | Total --- | --- | --- | --- | --- | --- -[v1.0.127](https://github.com/laurent22/joplin/releases/tag/v1.0.127) | 2019-02-14T23:12:48Z | 7,176 | 2,560 | 2,068 | 11,804 -[v1.0.126](https://github.com/laurent22/joplin/releases/tag/v1.0.126) | 2019-02-09T19:46:16Z | 785 | 44 | 102 | 931 +[v1.0.127](https://github.com/laurent22/joplin/releases/tag/v1.0.127) | 2019-02-14T23:12:48Z | 7,426 | 2,655 | 2,222 | 12,303 +[v1.0.126](https://github.com/laurent22/joplin/releases/tag/v1.0.126) | 2019-02-09T19:46:16Z | 797 | 44 | 102 | 943 [v1.0.125](https://github.com/laurent22/joplin/releases/tag/v1.0.125) | 2019-01-26T18:14:33Z | 10,219 | 3,513 | 1,686 | 15,418 [v1.0.120](https://github.com/laurent22/joplin/releases/tag/v1.0.120) | 2019-01-10T21:42:53Z | 15,549 | 5,155 | 6,471 | 27,175 [v1.0.119](https://github.com/laurent22/joplin/releases/tag/v1.0.119) | 2018-12-18T12:40:22Z | 8,850 | 3,198 | 1,989 | 14,037 [v1.0.118](https://github.com/laurent22/joplin/releases/tag/v1.0.118) | 2019-01-11T08:34:13Z | 674 | 215 | 75 | 964 [v1.0.117](https://github.com/laurent22/joplin/releases/tag/v1.0.117) | 2018-11-24T12:05:24Z | 16,203 | 4,842 | 6,351 | 27,396 [v1.0.116](https://github.com/laurent22/joplin/releases/tag/v1.0.116) | 2018-11-20T19:09:24Z | 3,456 | 1,087 | 704 | 5,247 -[v1.0.115](https://github.com/laurent22/joplin/releases/tag/v1.0.115) | 2018-11-16T16:52:02Z | 3,625 | 1,276 | 780 | 5,681 +[v1.0.115](https://github.com/laurent22/joplin/releases/tag/v1.0.115) | 2018-11-16T16:52:02Z | 3,626 | 1,276 | 780 | 5,682 [v1.0.114](https://github.com/laurent22/joplin/releases/tag/v1.0.114) | 2018-10-24T20:14:10Z | 11,363 | 3,475 | 3,821 | 18,659 [v1.0.111](https://github.com/laurent22/joplin/releases/tag/v1.0.111) | 2018-09-30T20:15:09Z | 11,856 | 3,123 | 3,646 | 18,625 [v1.0.110](https://github.com/laurent22/joplin/releases/tag/v1.0.110) | 2018-09-29T12:29:21Z | 926 | 376 | 103 | 1,405 @@ -41,7 +41,7 @@ Version | Date | Windows | macOS | Linux | Total [v1.0.91](https://github.com/laurent22/joplin/releases/tag/v1.0.91) | 2018-05-10T14:48:04Z | 814 | 535 | 290 | 1,639 [v1.0.89](https://github.com/laurent22/joplin/releases/tag/v1.0.89) | 2018-05-09T13:05:05Z | 476 | 212 | 97 | 785 [v1.0.85](https://github.com/laurent22/joplin/releases/tag/v1.0.85) | 2018-05-01T21:08:24Z | 1,641 | 934 | 613 | 3,188 -[v1.0.83](https://github.com/laurent22/joplin/releases/tag/v1.0.83) | 2018-04-04T19:43:58Z | 4,509 | 2,397 | 2,627 | 9,533 +[v1.0.83](https://github.com/laurent22/joplin/releases/tag/v1.0.83) | 2018-04-04T19:43:58Z | 4,509 | 2,399 | 2,627 | 9,535 [v1.0.82](https://github.com/laurent22/joplin/releases/tag/v1.0.82) | 2018-03-31T19:16:31Z | 684 | 384 | 93 | 1,161 [v1.0.81](https://github.com/laurent22/joplin/releases/tag/v1.0.81) | 2018-03-28T08:13:58Z | 984 | 566 | 743 | 2,293 [v1.0.79](https://github.com/laurent22/joplin/releases/tag/v1.0.79) | 2018-03-23T18:00:11Z | 919 | 509 | 353 | 1,781 @@ -76,7 +76,7 @@ Version | Date | Windows | macOS | Linux | Total [v0.10.30](https://github.com/laurent22/joplin/releases/tag/v0.10.30) | 2017-11-30T20:28:16Z | 711 | 1,340 | 410 | 2,461 [v0.10.28](https://github.com/laurent22/joplin/releases/tag/v0.10.28) | 2017-11-30T01:07:46Z | 1,268 | 1,670 | 864 | 3,802 [v0.10.26](https://github.com/laurent22/joplin/releases/tag/v0.10.26) | 2017-11-29T16:02:17Z | 180 | 673 | 255 | 1,108 -[v0.10.25](https://github.com/laurent22/joplin/releases/tag/v0.10.25) | 2017-11-24T14:27:49Z | 136 | 664 | 5,207 | 6,007 +[v0.10.25](https://github.com/laurent22/joplin/releases/tag/v0.10.25) | 2017-11-24T14:27:49Z | 136 | 664 | 5,208 | 6,008 [v0.10.23](https://github.com/laurent22/joplin/releases/tag/v0.10.23) | 2017-11-21T19:38:41Z | 124 | 616 | 20 | 760 [v0.10.22](https://github.com/laurent22/joplin/releases/tag/v0.10.22) | 2017-11-20T21:45:57Z | 76 | 615 | 11 | 702 [v0.10.21](https://github.com/laurent22/joplin/releases/tag/v0.10.21) | 2017-11-18T00:53:15Z | 44 | 607 | 4 | 655