diff --git a/guides/reference-guides/javascript-client-reference/typedef.md b/guides/reference-guides/javascript-client-reference/typedef.md index a8b21775..f9e07508 100644 --- a/guides/reference-guides/javascript-client-reference/typedef.md +++ b/guides/reference-guides/javascript-client-reference/typedef.md @@ -1,7 +1,7 @@ # TypeDef ##### TypeDef -Type definations +Type definitions ## DocParamsGet @@ -150,6 +150,20 @@ the DELETE document interface query parameters | [schema] | boolean | if set to true, a schema graph will be created | +## DbDoc +##### DbDoc: ` Object` +**Properties** + +| Name | Type | Description | +| --- | --- | --- | +| id | string | "Database ID" | +| [label] | string | "Textual DB Name" | +| [comment] | string | "Text description of DB" | +| [organization] | string | "Organization to which the db belongs" | +| [public] | boolean | - | +| [schema] | boolean | if set to true, a schema graph will be created | + + ## RemoteRepoDetails ##### RemoteRepoDetails: ` Object` {remote: "origin", "remote_branch": "main", "author": diff --git a/guides/reference-guides/javascript-client-reference/woqlclient.md b/guides/reference-guides/javascript-client-reference/woqlclient.md index b4ae53f0..ddc75bb4 100644 --- a/guides/reference-guides/javascript-client-reference/woqlclient.md +++ b/guides/reference-guides/javascript-client-reference/woqlclient.md @@ -550,16 +550,14 @@ const branch_resource = client.resource("branch") ``` ## updateDatabase -##### woqlClient.updateDatabase(dbId, dbDetails, [orgId]) ⇒ Promise +##### woqlClient.updateDatabase(dbDoc) ⇒ Promise Update a database in TerminusDB server **Returns**: Promise - A promise that returns the call response object, or an Error if rejected. | Param | Type | Description | | --- | --- | --- | -| dbId | string | The id of the database to be updated | -| dbDetails | typedef.DbDetails | object containing details about the database to be updated | -| [orgId] | string | optional organization id - if absent default local organization id is used | +| dbDoc | typedef.DbDoc | object containing details about the database to be updated | **Example** ```javascript