code.H3RALD.com — litestore: 87eb123102b5cba82254a40c2340d3efc92d868a

Fixed docs.

h3rald h3rald@h3rald.com

Sat, 05 Sep 2020 14:09:46 +0200

commit

87eb123102b5cba82254a40c2340d3efc92d868a

parent

c32be99d31c4b8da56a01d660efe44d3a137f163

5 files changed, 22 insertions(+), 22 deletions(-)

jump to

build_guide

src/admin/md/api_stores.md

src/admin/md/nim-api_high.md

src/admin/md/nim-api_low.md

src/litestorepkg/lib/config.nim

M build_guide → build_guide

@@ -30,7 +30,7 @@ for page in ${pages[@]}
 do
   (cat "${page}"; printf "\n\n") >> LiteStore_UserGuide.md
 done
-hastyscribe --field/version:1.9.0 LiteStore_UserGuide.md
+hastyscribe --field/version:1.9.1 LiteStore_UserGuide.md
 rm LiteStore_UserGuide.md
 mv LiteStore_UserGuide.htm ..
 cd ../..

M src/admin/md/api_stores.md → src/admin/md/api_stores.md

@@ -41,7 +41,7 @@ access-control-allow-methods: GET,OPTIONS,PUT,DELETE
 Content-Length: 0
 ```
 
-#### GET indexes
+#### GET stores
 
 Retrieves information on all available stores (file name and configuration).

M src/admin/md/nim-api_high.md → src/admin/md/nim-api_high.md

@@ -12,13 +12,13 @@ ##### Parameters
 
 <dl>
 <dt>resource</dt>
-<dd>The resource to perform the operation on ([info](class:kwd) or [docs](class:kwd)).</dd>
+<dd>The resource to perform the operation on <span class="kwd">info</span> or <span class="kwd">docs</span>.</dd>
 <dt>id</dt> 
 <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>params</dt>
 <dd>The parameters to pass to the operation (see the corresponding HTTP querystring parameters).</dd>
 <dt>headers</dt>
-<dd>An [HttpHeaders](class:kwd) object containing the headers of the request. Use the [Content-Type](class:kwd) header to specify the content type of the [body](class:kwd) parameter.</dd>
+<dd>An <span class="kwd">HttpHeaders</span> object containing the headers of the request. Use the <span class="kwd">Content-Type</span> header to specify the content type of the <span class="kwd">body</span> parameter.</dd>
 </dl>
 
 #### post
@@ -31,13 +31,13 @@ ##### Parameters
 
 <dl>
 <dt>resource</dt>
-<dd>The resource to perform the operation on ([info](class:kwd) or [docs](class:kwd)).</dd>
+<dd>The resource to perform the operation on <span class="kwd">info</span> or <span class="kwd">docs</span>.</dd>
 <dt>folder</dt>
 <dd>The folder that will contain the resource (set to an empty string if not needed).</dd>
 <dt>body</dt>
 <dd>The request body.</dd>
 <dt>headers</dt>
-<dd>An [HttpHeaders](class:kwd) object containing the headers of the request. Use the [Content-Type](class:kwd) header to specify the content type of the [body](class:kwd) parameter.</dd>
+<dd>An <span class="kwd">HttpHeaders</span> object containing the headers of the request. Use the <span class="kwd">Content-Type</span> header to specify the content type of the <span class="kwd">body</span> parameter.</dd>
 </dl>
 
 #### put
@@ -50,13 +50,13 @@ ##### Parameters
 
 <dl>
 <dt>resource</dt>
-<dd>The resource to perform the operation on ([info](class:kwd) or [docs](class:kwd)).</dd>
+<dd>The resource to perform the operation on <span class="kwd">info</span> or <span class="kwd">docs</span>.</dd>
 <dt>id</dt> 
 <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>body</dt>
 <dd>The request body.</dd>
 <dt>headers</dt>
-<dd>An [HttpHeaders](class:kwd) object containing the headers of the request. Use the [Content-Type](class:kwd) header to specify the content type of the [body](class:kwd) parameter.</dd>
+<dd>An <span class="kwd">HttpHeaders</span> object containing the headers of the request. Use the <span class="kwd">Content-Type</span> header to specify the content type of the <span class="kwd">body</span> parameter.</dd>
 </dl>
 
 #### patch
@@ -69,13 +69,13 @@ ##### Parameters
 
 <dl>
 <dt>resource</dt>
-<dd>The resource to perform the operation on ([info](class:kwd) or [docs](class:kwd)).</dd>
+<dd>The resource to perform the operation on <span class="kwd">info</span> or <span class="kwd">docs</span>.</dd>
 <dt>id</dt> 
 <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>body</dt>
 <dd>The request body.</dd>
 <dt>headers</dt>
-<dd>An [HttpHeaders](class:kwd) object containing the headers of the request. Use the [Content-Type](class:kwd) header to specify the content type of the [body](class:kwd) parameter.</dd>
+<dd>An <span class="kwd">HttpHeaders</span> object containing the headers of the request. Use the <span class="kwd">Content-Type</span> header to specify the content type of the <span class="kwd">body</span> parameter.</dd>
 </dl>
 
 #### delete
@@ -88,11 +88,11 @@ ##### Parameters
 
 <dl>
 <dt>resource</dt>
-<dd>The resource to perform the operation on ([info](class:kwd) or [docs](class:kwd)).</dd>
+<dd>The resource to perform the operation on <span class="kwd">info</span> or <span class="kwd">docs</span>.</dd>
 <dt>id</dt> 
 <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>headers</dt>
-<dd>An [HttpHeaders](class:kwd) object containing the headers of the request. Use the [Content-Type](class:kwd) header to specify the content type of the [body](class:kwd) parameter.</dd>
+<dd>An <span class="kwd">HttpHeaders</span> object containing the headers of the request. Use the <span class="kwd">Content-Type</span> header to specify the content type of the <span class="kwd">body</span> parameter.</dd>
 </dl>
 
 #### head
@@ -105,11 +105,11 @@ ##### Parameters
 
 <dl>
 <dt>resource</dt>
-<dd>The resource to perform the operation on ([info](class:kwd) or [docs](class:kwd)).</dd>
+<dd>The resource to perform the operation on <span class="kwd">info</span> or <span class="kwd">docs</span>.</dd>
 <dt>id</dt> 
 <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>headers</dt>
-<dd>An [HttpHeaders](class:kwd) object containing the headers of the request. Use the [Content-Type](class:kwd) header to specify the content type of the [body](class:kwd) parameter.</dd>
+<dd>An <span class="kwd">HttpHeaders</span> object containing the headers of the request. Use the <span class="kwd">Content-Type</span> header to specify the content type of the <span class="kwd">body</span> parameter.</dd>
 </dl>
 
 #### options
@@ -122,9 +122,9 @@ ##### Parameters
 
 <dl>
 <dt>resource</dt>
-<dd>The resource to perform the operation on ([info](class:kwd) or [docs](class:kwd)).</dd>
+<dd>The resource to perform the operation on <span class="kwd">info</span> or <span class="kwd">docs</span>.</dd>
 <dt>id</dt> 
 <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>headers</dt>
-<dd>An [HttpHeaders](class:kwd) object containing the headers of the request. Use the [Content-Type](class:kwd) header to specify the content type of the [body](class:kwd) parameter.</dd>
+<dd>An <span class="kwd">HttpHeaders</span> object containing the headers of the request. Use the <span class="kwd">Content-Type</span> header to specify the content type of the <span class="kwd">body</span> parameter.</dd>
 </dl>

M src/admin/md/nim-api_low.md → src/admin/md/nim-api_low.md

@@ -18,7 +18,7 @@ ##### Parameters
 
 <dl>
 <dt>options</dt>
-<dd>A [QueryOptions](#QueryOptions) object representing a query to execute on a document.</dd>
+<dd>A <a href="#QueryOptions">QueryOptions</a> object representing a query to execute on a document.</dd>
 </dl>
 
 #### getDocument
@@ -33,7 +33,7 @@ <dl>
 <dt>id</dt> 
 <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>options</dt>
-<dd>A [QueryOptions](#QueryOptions) object representing a query to execute on a document.</dd>
+<dd>A <a href="#QueryOptions">QueryOptions</a> object representing a query to execute on a document.</dd>
 </dl>
 
 #### getRawDocument
@@ -48,7 +48,7 @@ <dl>
 <dt>id</dt> 
 <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>options</dt>
-<dd>A [QueryOptions](#QueryOptions) object representing a query to execute on a document.</dd>
+<dd>A <a href="#QueryOptions">QueryOptions</a> object representing a query to execute on a document.</dd>
 </dl>
 
 #### deleteDocument
@@ -76,7 +76,7 @@ <dl>
 <dt>body</dt>
 <dd>The request body.</dd>
 <dt>ct</dt>
-<dd>Determines the content type of the [body](class:kwd) parameter.</dd>
+<dd>Determines the content type of the <span class="kwd">body</span> parameter.</dd>
 <dt>folder</dt>
 <dd>A logical folder where the document will be saved.</dd>
 </dl>
@@ -95,7 +95,7 @@ <dd>The identifier of the resource (set to an empty string if not needed).</dd>
 <dt>body</dt>
 <dd>The request body.</dd>
 <dt>ct</dt>
-<dd>Determines the content type of the [body](class:kwd) parameter.</dd>
+<dd>Determines the content type of the <span class="kwd">body</span> parameter.</dd>
 </dl>
 
 #### patchDocument

M src/litestorepkg/lib/config.nim → src/litestorepkg/lib/config.nim

@@ -1,6 +1,6 @@ 
 const
   pkgName*        = "litestore"
-  pkgVersion*     = "1.9.0"
+  pkgVersion*     = "1.9.1"
   pkgAuthor*      = "Fabio Cevasco"
   pkgDescription* = "Self-contained, lightweight, RESTful document store."
   pkgLicense*     = "MIT"

all repos — litestore @ 87eb123102b5cba82254a40c2340d3efc92d868a

A minimalist nosql document store.