Node API updated.

Author: smelamud

_data/node_api.yml

@@ -2793,13 +2793,35 @@ objects:
       Search API is implemented by nodes acting as search engines in the Moera network.
     requests:
       - url: /search/nodes
-        type: GET
+        type: POST
         function: searchNodes
+        in:
+          struct: SearchNodeFilter
+          name: filter
+        out:
+          struct: SearchNodePageInfo
+        auth: optional
+        description: >
+          Search for Moera nodes matching the search <code>query</code>. Every space-delimited word in the query must
+          match case-insensitively a beginning of the node's name or a beginning of any non-letter-delimited word in
+          the node's full name. The order of words is not significant.
+          <br><br>
+          The search engine may decide to return fewer nodes than the given <code>limit</code>.
+          <br><br>
+          The returned nodes are sorted by their relevance. The exact definition of this term is left to the search
+          engine's implementation.
+      - url: /search/nodes/suggestions
+        type: GET
+        function: searchNodeSuggestions
         query:
           - type: String
             name: query
             optional: true
             description: the search query
+          - type: String
+            name: sheriff
+            optional: true
+            description: filter out entries prohibited by the given sheriff
           - type: int
             name: limit
             optional: true
@@ -2809,9 +2831,10 @@ objects:
           array: true
         auth: optional
         description: >
-          Search for Moera nodes matching the search <code>query</code>. Every space-delimited word in the query must
-          match case-insensitively a beginning of the node's name or a beginning of any non-letter-delimited word in
-          the node's full name. The order of words is not significant.
+          Search for Moera nodes matching the search <code>query</code> and return a short list of "smart suggestions"
+          for the user. Every space-delimited word in the query must match case-insensitively a beginning of the node's
+          name or a beginning of any non-letter-delimited word in the node's full name. The order of words is
+          not significant.
           <br><br>
           The search engine may decide to return fewer nodes than the given <code>limit</code>.
           <br><br>
@@ -6850,6 +6873,10 @@ structures:
       - struct: Body
         name: bodyPreview
         description: preview of the entry's body, a string representation of a JSON structure
+      - enum: BodyFormat
+        name: bodyFormat
+        optional: true
+        description: format of the entry's body, may have any value meaningful for the client
       - type: String
         name: heading
         description: heading of the entry
@@ -6976,6 +7003,31 @@ structures:
         array: true
         name: entries
         description: the entries
+  - name: SearchNodeFilter
+    fields:
+      - type: String
+        name: query
+        description: the search query
+      - type: String
+        name: sheriffName
+        optional: true
+        description: filter out nodes prohibited by the given sheriff
+      - type: int
+        name: page
+        optional: true
+        description: page number, 0 by default
+        constraints:
+          - value:
+              min: 0
+              error: page.invalid
+      - type: int
+        name: limit
+        optional: true
+        description: page size (maximum number of entries returned), the default is set by the search engine
+        constraints:
+          - value:
+              min: 0
+              error: limit.invalid
   - name: SearchNodeInfo
     fields:
       - type: String
@@ -6995,6 +7047,18 @@ structures:
       - type: float
         name: distance
         description: social distance between the node and the client
+  - name: SearchNodePageInfo
+    fields:
+      - type: int
+        name: page
+        description: number of the page
+      - type: int
+        name: total
+        description: total number of nodes found (this number may be approximate)
+      - struct: SearchNodeInfo
+        array: true
+        name: nodes
+        description: the nodes
   - name: SearchPostingUpdate
     fields:
       - type: String
@@ -7196,7 +7260,7 @@ structures:
         description: number of the page
       - type: int
         name: total
-        description: total number of pages
+        description: total number of entries found
       - struct: SearchEntryInfo
         array: true
         name: entries

_data/py_node_api.yml

@@ -3217,11 +3217,28 @@ objects:
       The returned nodes are sorted by their relevance. The exact definition of this
       term is left to the search engine''s implementation.
 
+      '
+    function: search_nodes(filter)
+    out:
+      struct: SearchNodePageInfo
+    params:
+    - name: filter
+      struct: SearchNodeFilter
+  - auth: optional
+    description: 'Search for Moera nodes matching the search <code>query</code> and
+      return a short list of "smart suggestions" for the user. Every space-delimited
+      word in the query must match case-insensitively a beginning of the node''s name
+      or a beginning of any non-letter-delimited word in the node''s full name. The
+      order of words is not significant. <br><br> The search engine may decide to
+      return fewer nodes than the given <code>limit</code>. <br><br> The returned
+      nodes are sorted by their relevance. The exact definition of this term is left
+      to the search engine''s implementation.
+
       '
     errors:
     - code: limit.invalid
       description: <code>limit</code> parameter has an invalid value
-    function: search_nodes(query=None, limit=None)
+    function: search_node_suggestions(query=None, sheriff=None, limit=None)
     out:
       array: true
       struct: SearchNodeInfo
@@ -3230,6 +3247,10 @@ objects:
       name: query
       optional: true
       type: str
+    - description: filter out entries prohibited by the given sheriff
+      name: sheriff
+      optional: true
+      type: str
     - description: maximum number of nodes returned
       name: limit
       optional: true
@@ -7655,6 +7676,11 @@ structures:
   - description: preview of the entry's body, a string representation of a JSON structure
     name: body_preview
     struct: Body
+  - description: format of the entry's body, may have any value meaningful for the
+      client
+    enum: BodyFormat
+    name: body_format
+    optional: true
   - description: heading of the entry
     name: heading
     type: str
@@ -7791,6 +7817,32 @@ structures:
     name: entries
     struct: SearchEntryInfo
   name: SearchHashtagSliceInfo
+- fields:
+  - description: the search query
+    name: query
+    type: str
+  - description: filter out nodes prohibited by the given sheriff
+    name: sheriff_name
+    optional: true
+    type: str
+  - constraints:
+    - value:
+        error: page.invalid
+        min: 0
+    description: page number, 0 by default
+    name: page
+    optional: true
+    type: int
+  - constraints:
+    - value:
+        error: limit.invalid
+        min: 0
+    description: page size (maximum number of entries returned), the default is set
+      by the search engine
+    name: limit
+    optional: true
+    type: int
+  name: SearchNodeFilter
 - fields:
   - name: node_name
     type: str
@@ -7810,6 +7862,18 @@ structures:
     name: distance
     type: float
   name: SearchNodeInfo
+- fields:
+  - description: number of the page
+    name: page
+    type: int
+  - description: total number of nodes found (this number may be approximate)
+    name: total
+    type: int
+  - array: true
+    description: the nodes
+    name: nodes
+    struct: SearchNodeInfo
+  name: SearchNodePageInfo
 - fields:
   - constraints:
     - length:
@@ -8017,7 +8081,7 @@ structures:
   - description: number of the page
     name: page
     type: int
-  - description: total number of pages
+  - description: total number of entries found
     name: total
     type: int
   - array: true

_data/ts_node_api.yml

@@ -3214,11 +3214,28 @@ objects:
       The returned nodes are sorted by their relevance. The exact definition of this
       term is left to the search engine''s implementation.
 
+      '
+    function: searchNodes(filter)
+    out:
+      struct: SearchNodePageInfo
+    params:
+    - name: filter
+      struct: SearchNodeFilter
+  - auth: optional
+    description: 'Search for Moera nodes matching the search <code>query</code> and
+      return a short list of "smart suggestions" for the user. Every space-delimited
+      word in the query must match case-insensitively a beginning of the node''s name
+      or a beginning of any non-letter-delimited word in the node''s full name. The
+      order of words is not significant. <br><br> The search engine may decide to
+      return fewer nodes than the given <code>limit</code>. <br><br> The returned
+      nodes are sorted by their relevance. The exact definition of this term is left
+      to the search engine''s implementation.
+
       '
     errors:
     - code: limit.invalid
       description: <code>limit</code> parameter has an invalid value
-    function: searchNodes(query=null, limit=null)
+    function: searchNodeSuggestions(query=null, sheriff=null, limit=null)
     out:
       array: true
       struct: SearchNodeInfo
@@ -3227,6 +3244,10 @@ objects:
       name: query
       optional: true
       type: string
+    - description: filter out entries prohibited by the given sheriff
+      name: sheriff
+      optional: true
+      type: string
     - description: maximum number of nodes returned
       name: limit
       optional: true
@@ -7652,6 +7673,11 @@ structures:
   - description: preview of the entry's body, a string representation of a JSON structure
     name: bodyPreview
     struct: Body
+  - description: format of the entry's body, may have any value meaningful for the
+      client
+    enum: BodyFormat
+    name: bodyFormat
+    optional: true
   - description: heading of the entry
     name: heading
     type: string
@@ -7788,6 +7814,32 @@ structures:
     name: entries
     struct: SearchEntryInfo
   name: SearchHashtagSliceInfo
+- fields:
+  - description: the search query
+    name: query
+    type: string
+  - description: filter out nodes prohibited by the given sheriff
+    name: sheriffName
+    optional: true
+    type: string
+  - constraints:
+    - value:
+        error: page.invalid
+        min: 0
+    description: page number, 0 by default
+    name: page
+    optional: true
+    type: number
+  - constraints:
+    - value:
+        error: limit.invalid
+        min: 0
+    description: page size (maximum number of entries returned), the default is set
+      by the search engine
+    name: limit
+    optional: true
+    type: number
+  name: SearchNodeFilter
 - fields:
   - name: nodeName
     type: string
@@ -7807,6 +7859,18 @@ structures:
     name: distance
     type: number
   name: SearchNodeInfo
+- fields:
+  - description: number of the page
+    name: page
+    type: number
+  - description: total number of nodes found (this number may be approximate)
+    name: total
+    type: number
+  - array: true
+    description: the nodes
+    name: nodes
+    struct: SearchNodeInfo
+  name: SearchNodePageInfo
 - fields:
   - constraints:
     - length:
@@ -8014,7 +8078,7 @@ structures:
   - description: number of the page
     name: page
     type: number
-  - description: total number of pages
+  - description: total number of entries found
     name: total
     type: number
   - array: true

development/java-moeralib/javadoc/allclasses-index.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (17) on Tue May 13 03:25:59 IDT 2025 -->
-<title>All Classes and Interfaces (moeralib 0.16.6 API)</title>
+<!-- Generated by javadoc (17) on Thu May 22 02:02:25 IDT 2025 -->
+<title>All Classes and Interfaces (moeralib 0.16.8 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2025-05-13">
+<meta name="dc.created" content="2025-05-22">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -779,7 +779,11 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/moera/lib/node/types/SearchHashtagSliceInfo.html" title="class in org.moera.lib.node.types">SearchHashtagSliceInfo</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/moera/lib/node/types/SearchNodeInfo.html" title="class in org.moera.lib.node.types">SearchNodeInfo</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/moera/lib/node/types/SearchNodeFilter.html" title="class in org.moera.lib.node.types">SearchNodeFilter</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/moera/lib/node/types/SearchNodeInfo.html" title="class in org.moera.lib.node.types">SearchNodeInfo</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/moera/lib/node/types/SearchNodePageInfo.html" title="class in org.moera.lib.node.types">SearchNodePageInfo</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/moera/lib/node/types/SearchPostingUpdate.html" title="class in org.moera.lib.node.types">SearchPostingUpdate</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>

development/java-moeralib/javadoc/allpackages-index.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (17) on Tue May 13 03:25:59 IDT 2025 -->
-<title>All Packages (moeralib 0.16.6 API)</title>
+<!-- Generated by javadoc (17) on Thu May 22 02:02:25 IDT 2025 -->
+<title>All Packages (moeralib 0.16.8 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2025-05-13">
+<meta name="dc.created" content="2025-05-22">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">