Skip to content

Commit

Permalink
Fix some RPC docs content (#877)
Browse files Browse the repository at this point in the history
  • Loading branch information
@macjuul
macjuul authored Sep 20, 2024
1 parent b898463 commit 8df470d
Showing 1 changed file with 10 additions and 19 deletions.
29 changes: 10 additions & 19 deletions src/content/doc-surrealdb/integration/rpc.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ This method does not accept any parameters.

## `signup`

This method allows you to signup a user using the `SIGNUP` query defined in a record access method
This method allows you to sign a user up using the `SIGNUP` query defined in a record access method

```json title="Method Syntax"
signup [ NS, DB, AC, ... ]
Expand Down Expand Up @@ -321,7 +321,7 @@ signup [ NS, DB, AC, ... ]
<Label label="required" />
</td>
<td colspan="2" scope="row" data-label="Description">
Specifies any variables used by the SIGNUP query or the record access method
Specifies any variables used by the SIGNUP query of the record access method
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -356,7 +356,7 @@ signup [ NS, DB, AC, ... ]

## `signin`

This method allows you to signin as a root, NS, DB user or with an access method against SurrealDB
This method allows you to sign in as a root, namespace, or database user, or with a record access method

```json title="Method Syntax"
signin [ NS, DB, AC, ... ]
Expand All @@ -377,7 +377,7 @@ signin [ NS, DB, AC, ... ]
<Label label="required"></Label>
</td>
<td colspan="2" scope="row" data-label="Description">
The namespace to sign in to. This data is `REQUIRED FOR DB & RECORD`
The namespace to sign in to. Only required for `DB & RECORD` authentication
</td>
</tr>
<tr>
Expand All @@ -386,7 +386,7 @@ signin [ NS, DB, AC, ... ]
<Label label="required"></Label>
</td>
<td colspan="2" scope="row" data-label="Description">
The database to sign in to. This data is `REQUIRED FOR RECORD`
The database to sign in to. Only required for `RECORD` authentication
</td>
</tr>
<tr>
Expand All @@ -395,7 +395,7 @@ signin [ NS, DB, AC, ... ]
<Label label="required"></Label>
</td>
<td colspan="2" scope="row" data-label="Description">
Specifies the access method. This data is `REQUIRED FOR RECORD`
Specifies the access method. Only required for `RECORD` authentication
</td>
</tr>
<tr>
Expand All @@ -404,7 +404,7 @@ signin [ NS, DB, AC, ... ]
<Label label="required">REQUIRED FOR ROOT, NS & DB</Label>
</td>
<td colspan="2" scope="row" data-label="Description">
The username of the database user. This data is `REQUIRED FOR ROOT, NS & DB`
The username of the database user. Only required for `ROOT, NS & DB` authentication
</td>
</tr>
<tr>
Expand All @@ -413,15 +413,15 @@ signin [ NS, DB, AC, ... ]
<Label label="required">REQUIRED FOR ROOT, NS & DB</Label>
</td>
<td colspan="2" scope="row" data-label="Description">
The password of the database user. This data is `REQUIRED FOR ROOT, NS & DB`
The password of the database user. Only required for `ROOT, NS & DB` authentication
</td>
</tr>
<tr>
<td colspan="2" scope="row" data-label="Parameter">
<code>...</code>
</td>
<td colspan="2" scope="row" data-label="Description">
Specifies any variables used by the record's SIGNIN method
Specifies any variables to pass to the `SIGNIN` query. Only relevant for `RECORD` authentication
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -996,16 +996,7 @@ graphql [ query, options? ]
<Label label="optional" />
</td>
<td colspan="2" scope="row" data-label="Description">
An object specifying options like `pretty` output or response `format`.
</td>
</tr>
<tr>
<td colspan="2" scope="row" data-label="Parameter">
<code>pretty</code>
<Label label="optional" />
</td>
<td colspan="2" scope="row" data-label="Description">
A boolean indicating whether the output should be pretty-printed.
An object specifying options such as the output format and pretty-printing.
</td>
</tr>
</tbody>
Expand Down

0 comments on commit 8df470d

Please sign in to comment.