Update website

2025-01-23 18:53:36 +02:00 · 2019-02-24 12:38:20 +00:00 · 2019-02-24 12:38:20 +00:00 · 849cb4456c
commit 849cb4456c
parent 1736717f2e
5 changed files with 58 additions and 46 deletions
--- a/docs/api/index.html
+++ b/docs/api/index.html
@ -285,7 +285,9 @@ for (let portToTest = 41184; portToTest &lt;= 41194; portToTest++) {
 <pre><code>curl http://localhost:41184/notes/ABCD123?fields=longitude,latitude
 </code></pre><p>To get the IDs only of all the tags:</p>
 <pre><code>curl http://localhost:41184/tags?fields=id
-</code></pre><h1 id="about-the-property-types">About the property types</h1>
+</code></pre><h1 id="error-handling">Error handling</h1>
+<p>In case of an error, an HTTP status code &gt;= 400 will be returned along with a JSON object that provides more info about the error. The JSON object is in the format <code>{ &quot;error&quot;: &quot;description of error&quot; }</code>.</p>
+<h1 id="about-the-property-types">About the property types</h1>
 <ul>
 <li>Text is UTF-8.</li>
 <li>All date/time are Unix timestamps in milliseconds.</li>
@ -293,6 +295,8 @@ for (let portToTest = 41184; portToTest &lt;= 41194; portToTest++) {
 </ul>
 <h1 id="testing-if-the-service-is-available">Testing if the service is available</h1>
 <p>Call <strong>GET /ping</strong> to check if the service is available. It should return &quot;JoplinClipperServer&quot; if it works.</p>
+<h1 id="searching">Searching</h1>
+<p>Call <strong>GET /search?query=YOUR_QUERY</strong> to search for notes. This end-point supports the <code>field</code> 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: <a href="https://joplin.cozic.net/#searching">https://joplin.cozic.net/#searching</a></p>
 <h1 id="notes">Notes</h1>
 <h2 id="properties">Properties</h2>
 <table>
--- a/docs/index.html
+++ b/docs/index.html
@ -559,42 +559,42 @@ $$
 <td>Basque</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/eu.po">eu</a></td>
 <td>juan.abasolo@ehu.eus</td>
-<td>57%</td>
+<td>56%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/es/catalonia.png" alt=""></td>
 <td>Catalan</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/ca.po">ca</a></td>
 <td>jmontane, 2018</td>
-<td>82%</td>
+<td>80%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/hr.png" alt=""></td>
 <td>Croatian</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/hr_HR.po">hr_HR</a></td>
 <td>Hrvoje Mandić (trbuhom@net.hr)</td>
-<td>46%</td>
+<td>45%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/cz.png" alt=""></td>
 <td>Czech</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/cs_CZ.po">cs_CZ</a></td>
 <td>Lukas Helebrandt (lukas@aiya.cz)</td>
-<td>72%</td>
+<td>71%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/dk.png" alt=""></td>
 <td>Dansk</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/da_DK.po">da_DK</a></td>
 <td>Morten Juhl-Johansen Zölde-Fejér (mjjzf@syntaktisk.</td>
-<td>74%</td>
+<td>72%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/de.png" alt=""></td>
 <td>Deutsch</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/de_DE.po">de_DE</a></td>
 <td>Michael Sonntag (ms@editorei.de)</td>
-<td>95%</td>
+<td>98%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/gb.png" alt=""></td>
@ -608,7 +608,7 @@ $$
 <td>Español</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/es_ES.po">es_ES</a></td>
 <td>Fernando Martín (f@mrtn.es)</td>
-<td>87%</td>
+<td>88%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/fr.png" alt=""></td>
@ -622,105 +622,105 @@ $$
 <td>Galician</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/gl_ES.po">gl_ES</a></td>
 <td>Marcos Lans (marcoslansgarza@gmail.com)</td>
-<td>73%</td>
+<td>71%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/it.png" alt=""></td>
 <td>Italiano</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/it_IT.po">it_IT</a></td>
 <td></td>
-<td>90%</td>
+<td>89%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/be.png" alt=""></td>
 <td>Nederlands</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/nl_BE.po">nl_BE</a></td>
 <td></td>
-<td>58%</td>
+<td>56%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/nl.png" alt=""></td>
 <td>Nederlands</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/nl_NL.po">nl_NL</a></td>
 <td>Heimen Stoffels (vistausss@outlook.com)</td>
-<td>87%</td>
+<td>86%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/no.png" alt=""></td>
 <td>Norwegian</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/nb_NO.po">nb_NO</a></td>
 <td>Mats Estensen (code@mxe.no)</td>
-<td>95%</td>
+<td>94%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/br.png" alt=""></td>
 <td>Português (Brasil)</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/pt_BR.po">pt_BR</a></td>
 <td>Renato Nunes Bastos (rnbastos@gmail.com)</td>
-<td>94%</td>
+<td>93%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/ro.png" alt=""></td>
 <td>Română</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/ro.po">ro</a></td>
 <td></td>
-<td>57%</td>
+<td>56%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/si.png" alt=""></td>
 <td>Slovenian</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/sl_SI.po">sl_SI</a></td>
 <td></td>
-<td>72%</td>
+<td>70%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/se.png" alt=""></td>
 <td>Svenska</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/sv.po">sv</a></td>
 <td>Jonatan Nyberg (jonatan@autistici.org)</td>
-<td>98%</td>
+<td>96%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/tr.png" alt=""></td>
 <td>Türkçe</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/tr_TR.po">tr_TR</a></td>
 <td>Zorbey Doğangüneş (zorbeyd@gmail.com)</td>
-<td>83%</td>
+<td>93%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/ru.png" alt=""></td>
 <td>Русский</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/ru_RU.po">ru_RU</a></td>
 <td>Artyom Karlov (artyom.karlov@gmail.com)</td>
-<td>88%</td>
+<td>98%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/cn.png" alt=""></td>
 <td>中文 (简体)</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/zh_CN.po">zh_CN</a></td>
 <td></td>
-<td>99%</td>
+<td>97%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/tw.png" alt=""></td>
 <td>中文 (繁體)</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/zh_TW.po">zh_TW</a></td>
 <td>penguinsam (samliu@gmail.com)</td>
-<td>87%</td>
+<td>86%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/jp.png" alt=""></td>
 <td>日本語</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/ja_JP.po">ja_JP</a></td>
 <td>AWASHIRO Ikuya (ikunya@gmail.com)</td>
-<td>94%</td>
+<td>93%</td>
 </tr>
 <tr>
 <td><img src="https://joplin.cozic.net/images/flags/country-4x3/kr.png" alt=""></td>
 <td>한국말</td>
 <td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/ko.po">ko</a></td>
 <td></td>
-<td>96%</td>
+<td>95%</td>
 </tr>
 </tbody>
 </table>
--- a/docs/stats/index.html
+++ b/docs/stats/index.html
@ -261,15 +261,15 @@
 <tbody>
 <tr>
 <td>Total Windows downloads</td>
-<td>180,491</td>
+<td>180,754</td>
 </tr>
 <tr>
 <td>Total macOs downloads</td>
-<td>86,259</td>
+<td>86,356</td>
 </tr>
 <tr>
 <td>Total Linux downloads</td>
-<td>66,897</td>
+<td>67,052</td>
 </tr>
 <tr>
 <td>Windows %</td>
@ -300,18 +300,18 @@
 <tr>
 <td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.127">v1.0.127</a></td>
 <td>2019-02-14T23:12:48Z</td>
-<td>7,176</td>
-<td>2,560</td>
-<td>2,068</td>
-<td>11,804</td>
+<td>7,426</td>
+<td>2,655</td>
+<td>2,222</td>
+<td>12,303</td>
 </tr>
 <tr>
 <td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.126">v1.0.126</a></td>
 <td>2019-02-09T19:46:16Z</td>
-<td>785</td>
+<td>797</td>
 <td>44</td>
 <td>102</td>
-<td>931</td>
+<td>943</td>
 </tr>
 <tr>
 <td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.125">v1.0.125</a></td>
@ -364,10 +364,10 @@
 <tr>
 <td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.115">v1.0.115</a></td>
 <td>2018-11-16T16:52:02Z</td>
-<td>3,625</td>
+<td>3,626</td>
 <td>1,276</td>
 <td>780</td>
-<td>5,681</td>
+<td>5,682</td>
 </tr>
 <tr>
 <td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.114">v1.0.114</a></td>
@ -541,9 +541,9 @@
 <td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.83">v1.0.83</a></td>
 <td>2018-04-04T19:43:58Z</td>
 <td>4,509</td>
-<td>2,397</td>
+<td>2,399</td>
 <td>2,627</td>
-<td>9,533</td>
+<td>9,535</td>
 </tr>
 <tr>
 <td><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.82">v1.0.82</a></td>
@ -822,8 +822,8 @@
 <td>2017-11-24T14:27:49Z</td>
 <td>136</td>
 <td>664</td>
-<td>5,207</td>
-<td>6,007</td>
+<td>5,208</td>
+<td>6,008</td>
 </tr>
 <tr>
 <td><a href="https://github.com/laurent22/joplin/releases/tag/v0.10.23">v0.10.23</a></td>
--- 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
--- 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