Search API added.

Author: smelamud

_data/node_api.yml

@@ -768,8 +768,8 @@ objects:
           <br><br>
           The node may decide to return fewer contacts than the given <code>limit</code>.
           <br><br>
-          The contacts are sorted by their <i>closeness</i> to the node, which is calculated from the number of
-          reactions and comments and their age.
+          The contacts are sorted by <i>social distance</i> from the node, which depends on their subscription and
+          friendship status and the number of recent reactions and comments.
         errors:
           - code: limit.invalid
             description: <code>limit</code> parameter has an invalid value
@@ -2757,6 +2757,38 @@ objects:
             description: sheriff's order is not found
           - code: sheriff-order.wrong-node
             description: the sheriff's order is related to a different node
+  - name: Search
+    description: >
+      Search API is implemented by nodes acting as search engines in the Moera network.
+    requests:
+      - url: /search/nodes
+        type: GET
+        function: searchNodes
+        query:
+          - type: String
+            name: query
+            optional: true
+            description: the search query
+          - type: int
+            name: limit
+            optional: true
+            description: maximum number of nodes returned
+        out:
+          struct: SearchNodeInfo
+          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.
+          <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
   - name: Settings
     description: >
       Settings - the node and client settings. The node settings affect the node behavior. Only those settings are
@@ -3081,6 +3113,8 @@ objects:
             description: there is no posting with the given ID
           - code: user-list.not-found
             description: there is no list of users with the given name
+          - code: subscriber.too-many
+            description: there are too many subscribers of this type
       - url: /people/subscribers/{id}
         type: GET
         function: getSubscriber
@@ -4489,10 +4523,10 @@ structures:
         name: avatar
         optional: true
       - type: float
-        name: closeness
+        name: distance
         description: >
-          closeness of the contact to the node, which is calculated from the number of reactions and comments and
-          their age
+          social distance between the contact and the node, which depends on subscription and friendship status and
+          the number recent reactions and comments
       - type: boolean
         name: hasFeedSubscriber
         optional: true
@@ -6690,6 +6724,25 @@ structures:
       - type: String
         name: sheriffName
         description: name of the sheriff that added the mark
+  - name: SearchNodeInfo
+    fields:
+      - type: String
+        name: nodeName
+      - type: String
+        name: fullName
+        optional: true
+        description: node owner's full name
+      - type: String
+        name: title
+        optional: true
+        description: node title
+      - struct: AvatarImage
+        name: avatar
+        optional: true
+        description: node owner's avatar
+      - type: float
+        name: distance
+        description: social distance between the node and the client
   - name: SettingInfo
     fields:
       - type: String
@@ -7776,9 +7829,6 @@ structures:
         name: reason
         optional: true
         description: subscription reason
-        constraints:
-          - notnull:
-              error: subscription.reason.missing
       - struct: SubscriptionOperations
         name: operations
         optional: true
@@ -8434,6 +8484,22 @@ enums:
       - name: all
         description: all permissions
         value: "0x3fffffff"
+  - name: SearchContentUpdateType
+    values:
+      - name: block
+        description: the node was blocked
+      - name: friend
+        description: the node was added to the list of friends
+      - name: profile
+        description: the profile was updated
+      - name: subscribe
+        description: subscribed to the node
+      - name: unblock
+        description: the node was unblocked
+      - name: unfriend
+        description: the node was removed from the list of friends
+      - name: unsubscribe
+        description: unsubscribed from the node
   - name: SearchEngine
     values:
       - name: google
@@ -8692,14 +8758,22 @@ enums:
     values:
       - name: feed
         description: subscribe to new stories in the feed
+        ordinal: 0
       - name: posting
         description: subscribe to updates to the posting
+        ordinal: 1
       - name: posting-comments
         description: subscribe to new comments to the posting
+        ordinal: 2
       - name: profile
         description: subscribe to updates to the node profile
+        ordinal: 3
+      - name: search
+        description: subscribe to updates to all content that may be indexed by a search engine
+        ordinal: 5
       - name: user-list
         description: subscribe to updates to the user list (its name is passed in <code>feedName</code> field)
+        ordinal: 4
   - name: VerificationStatus
     values:
       - name: running

_data/notifications.yml

@@ -1182,6 +1182,45 @@ notifications:
       - struct: AvatarImage
         name: commentOwnerAvatar
         comment: avatar of the comment owner
+  - type: SEARCH_CONTENT_UPDATED
+    ordinal: 36
+    description: >
+      Notification sent to a Moera search engine when some content on the node was updated and needs reindexing.
+    fields:
+      - type: String
+        name: subscriberId
+        comment: subscriber ID of the receiving node on the sending node
+        constraints:
+          - length:
+              max: 40
+              error: subscriber.subscriber-id.wrong-size
+        log: true
+      - enum: SearchContentUpdateType
+        name: updateType
+        comment: type of the content that was updated
+        constraints:
+          - notnull:
+              error: search.update-type.missing
+        log: true
+      - type: String
+        name: nodeName
+        comment: name of the node; the concrete meaning depends on the update type
+        constraints:
+          - length:
+              max: 40
+              error: search.node-name.wrong-size
+        log: true
+      - type: String
+        name: feedName
+        comment: name of the feed; used by subscription/unsubscription updates
+        constraints:
+          - length:
+              max: 63
+              error: search.feed-name.wrong-size
+        log: true
+      - enum: BlockedOperation
+        name: blockedOperation
+        comment: the operation being blocked/unblocked; used by updates about blocking/unblocking
   - type: SEARCH_ENGINE_CLICKED
     ordinal: 35
     description: The receiver's posting/comment/media has been visited on the sending node from a search engine.

_data/py_node_api.yml

@@ -202,6 +202,22 @@ enums:
   - description: all permissions
     name: all
     value: '0x3fffffff'
+- name: SearchContentUpdateType
+  values:
+  - description: the node was blocked
+    name: block
+  - description: the node was added to the list of friends
+    name: friend
+  - description: the profile was updated
+    name: profile
+  - description: subscribed to the node
+    name: subscribe
+  - description: the node was unblocked
+    name: unblock
+  - description: the node was removed from the list of friends
+    name: unfriend
+  - description: unsubscribed from the node
+    name: unsubscribe
 - name: SearchEngine
   values:
   - description: Google
@@ -458,15 +474,24 @@ enums:
   values:
   - description: subscribe to new stories in the feed
     name: feed
+    ordinal: 0
   - description: subscribe to updates to the posting
     name: posting
+    ordinal: 1
   - description: subscribe to new comments to the posting
     name: posting-comments
+    ordinal: 2
   - description: subscribe to updates to the node profile
     name: profile
+    ordinal: 3
+  - description: subscribe to updates to all content that may be indexed by a search
+      engine
+    name: search
+    ordinal: 5
   - description: subscribe to updates to the user list (its name is passed in <code>feedName</code>
       field)
     name: user-list
+    ordinal: 4
 - name: VerificationStatus
   values:
   - description: the verification is pending
@@ -1310,8 +1335,9 @@ objects:
       of the contact''s node name or a beginning of any space-delimited word in the
       contact''s full name. The order of words is not significant. <br><br> The node
       may decide to return fewer contacts than the given <code>limit</code>. <br><br>
-      The contacts are sorted by their <i>closeness</i> to the node, which is calculated
-      from the number of reactions and comments and their age.
+      The contacts are sorted by <i>social distance</i> from the node, which depends
+      on their subscription and friendship status and the number of recent reactions
+      and comments.
 
       '
     errors:
@@ -3119,6 +3145,38 @@ objects:
     - description: ID of the order
       name: id
       type: str
+- description: 'Search API is implemented by nodes acting as search engines in the
+    Moera network.
+
+    '
+  name: Search
+  requests:
+  - 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.
+
+      '
+    errors:
+    - code: limit.invalid
+      description: <code>limit</code> parameter has an invalid value
+    function: search_nodes(query=None, limit=None)
+    out:
+      array: true
+      struct: SearchNodeInfo
+    params:
+    - description: the search query
+      name: query
+      optional: true
+      type: str
+    - description: maximum number of nodes returned
+      name: limit
+      optional: true
+      type: int
 - description: 'Settings - the node and client settings. The node settings affect
     the node behavior. Only those settings are accepted that are known by the node,
     and their values are validated before saving. The node settings metadata can be
@@ -3423,6 +3481,8 @@ objects:
       description: there is no posting with the given ID
     - code: user-list.not-found
       description: there is no list of users with the given name
+    - code: subscriber.too-many
+      description: there are too many subscribers of this type
     function: create_subscriber(subscriber)
     out:
       struct: SubscriberInfo
@@ -5113,11 +5173,11 @@ structures:
   - name: avatar
     optional: true
     struct: AvatarImage
-  - description: 'closeness of the contact to the node, which is calculated from the
-      number of reactions and comments and their age
+  - description: 'social distance between the contact and the node, which depends
+      on subscription and friendship status and the number recent reactions and comments
 
       '
-    name: closeness
+    name: distance
     type: float
   - description: the contact is subscribed to at least one of the node's feeds
     name: has_feed_subscriber
@@ -7444,6 +7504,25 @@ structures:
     name: sheriff_name
     type: str
   name: SheriffMark
+- fields:
+  - name: node_name
+    type: str
+  - description: node owner's full name
+    name: full_name
+    optional: true
+    type: str
+  - description: node title
+    name: title
+    optional: true
+    type: str
+  - description: node owner's avatar
+    name: avatar
+    optional: true
+    struct: AvatarImage
+  - description: social distance between the node and the client
+    name: distance
+    type: float
+  name: SearchNodeInfo
 - fields:
   - description: name of the setting
     name: name
@@ -8577,10 +8656,7 @@ structures:
     name: remote_posting_id
     optional: true
     type: str
-  - constraints:
-    - notnull:
-        error: subscription.reason.missing
-    description: subscription reason
+  - description: subscription reason
     enum: SubscriptionReason
     name: reason
     optional: true