DOC-192: Improve PRC documentations (#830)

surrealdb · Sep 9, 2024 · e553731 · e553731
1 parent 6347401
commit e553731
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/doc-surrealdb_versioned_docs/version-latest/integration/rpc.mdx b/doc-surrealdb_versioned_docs/version-latest/integration/rpc.mdx
@@ -413,7 +413,7 @@ signin [ NS, DB, AC, ... ]
 
 ## `authenticate`
 
-This method specifies the namespace and database for the current connection
+This method allows you to authenticate a user against SurrealDB with a token
 
 ```json title="Method Syntax"
 authenticate [ token ]
@@ -485,7 +485,7 @@ invalidate
 
 ## `let` <l className='purple'>websocket only</l>
 
-This method specifies the namespace and database for the current connection
+This method stores a variable on the current connection
 
 ```json title="Method Syntax"
 let [ name, value ]
@@ -541,7 +541,7 @@ let [ name, value ]
 
 ## `unset` <l className='purple'>websocket only</l>
 
-This method specifies the namespace and database for the current connection
+This method removes a variable from the current connection
 
 ```json title="Method Syntax"
 unset [ name ]
@@ -588,6 +588,8 @@ unset [ name ]
 
 ## `live` <l className='purple'>websocket only</l>
 
+This methods initiates a live query for a specified table name
+
 ```json title="Method Syntax"
 live[ table ]
 ```
@@ -620,7 +622,7 @@ live[ table ]
                 <l className='grey'>OPTIONAL</l>
             </td>
             <td colspan="2" scope="row" data-label="Description">
-                The value for the variable
+                If set to true, live notifications will contain an array of [JSON Patches](https://jsonpatch.com) instead of the entire record
             </td>
         </tr>
     </tbody>
@@ -1013,6 +1015,8 @@ insert [ thing, data ]
 
 ## `update`
 
+This method replaces either all records in a table or a single record with specified data
+
 ```json title="Method Syntax"
 update [ thing, data ]
 ```
@@ -1247,7 +1251,7 @@ merge [ thing, data ]
         <tr>
             <td colspan="2" scope="row" data-label="Parameter">
                 <code>data</code>
-                <l className='yellow'>REQUIRED</l>
+                <l className='grey'>OPTIONAL</l>
             </td>
             <td colspan="2" scope="row" data-label="Description">
             The content of the record