Skip to content

Docs update #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 24, 2022
Merged

Docs update #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bdedb65
Apply docs changes
Francesca-Bit Aug 24, 2022
6a23a2c
update version
Francesca-Bit Aug 24, 2022
d0f4c0a
update version
Francesca-Bit Aug 24, 2022
099934a
Merge branch 'docs-update' of https://github.com/terminusdb/terminusd…
Francesca-Bit Aug 24, 2022
9c10b71
update version
Francesca-Bit Aug 24, 2022
4d7b460
update version
Francesca-Bit Aug 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const bankerSchema = [
"@type":"Class",
"@id":"Person",
"@key":{
"@type":"Hash",
"@type":"Lexical",
"@fields":[
"name"
]
Expand Down
4 changes: 3 additions & 1 deletion docs/_sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,10 @@
- [getPrefixes](api/woqlClient.js?id=getPrefixes)
- [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
- [userOrganizations](api/woqlClient.js?id=userOrganizations)
- [getDiff](api/woqlClient.js?id=getDiff)
- [getJSONDiff](api/woqlClient.js?id=getJSONDiff)
- [getVersionObjectDiff](api/woqlClient.js?id=getVersionObjectDiff)
- [getVersionDiff](api/woqlClient.js?id=getVersionDiff)
- [apply](api/woqlClient.js?id=apply)
- [patch](api/woqlClient.js?id=patch)
- [WOQL](api/woql.js?id=WOQL)
- [using](api/woql.js?id=using)
Expand Down Expand Up @@ -169,6 +170,7 @@
- [setApiToken](api/accessControl.js?id=setApiToken)
- [setApiKey](api/accessControl.js?id=setApiKey)
- [getAPIUrl](api/accessControl.js?id=getAPIUrl)
- [customHeaders](api/accessControl.js?id=customHeaders)
- [getAllOrganizations](api/accessControl.js?id=getAllOrganizations)
- [createOrganization](api/accessControl.js?id=createOrganization)
- [deleteOrganization](api/accessControl.js?id=deleteOrganization)
Expand Down
8 changes: 4 additions & 4 deletions docs/api/woqlclient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1132,7 +1132,7 @@ Get the patch of difference between two documents.
| --- | --- | --- |
| before | <code>object</code> | The current state of JSON document |
| after | <code>object</code> | The updated state of JSON document |
| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint. The diff api outputs the changes between the input (branches or commits), in options you can list the properties that you would like to see in the diff result in any case. |
| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint. The diff api outputs the changes between the input, in options you can list the properties that you would like to see in the diff result in any case. |

**Example**
```javascript
Expand All @@ -1157,8 +1157,8 @@ Get the patch of difference between two documents.
| --- | --- | --- |
| dataVersion | <code>string</code> | The version from which to compare the object |
| jsonObject | <code>object</code> | The updated state of JSON document |
| id | <code>string</code> | The object id to be diffed |
| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint the diff api outputs the changes between the input (branches or commits), but you can list the properties that you would like to see in the diff result in any case. |
| id | <code>string</code> | The document id to be diffed |
| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint the diff api outputs the changes between the input, but you can list the properties that you would like to see in the diff result in any case. |

**Example**
```javascript
Expand Down Expand Up @@ -1244,7 +1244,7 @@ Patch the difference between two documents.

**Example**
```javascript
let diffPatch = await client.getDiff(
let diffPatch = await client.getJSONDiff(
{ "@id": "Person/Jane", "@type": "Person", name: "Jane" },
{ "@id": "Person/Jane", "@type": "Person", name: "Janine" }
);
Expand Down
8 changes: 4 additions & 4 deletions lib/woqlClient.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1469,7 +1469,7 @@ WOQLClient.prototype.userOrganizations = function (orgList) {
* @param {object} before - The current state of JSON document
* @param {object} after - The updated state of JSON document
* @param {object} [options] - {keep:{}} Options to send to the diff endpoint.
* The diff api outputs the changes between the input (branches or commits),
* The diff api outputs the changes between the input,
* in options you can list the properties that you would like to see in the diff result in any case.
* @returns {Promise} A promise that returns the call response object, or an Error if rejected.
* @example
Expand Down Expand Up @@ -1505,9 +1505,9 @@ WOQLClient.prototype.getJSONDiff = function (before, after, options) {
* Get the patch of difference between two documents.
* @param {string} dataVersion - The version from which to compare the object
* @param {object} jsonObject - The updated state of JSON document
* @param {string} id - The object id to be diffed
* @param {string} id - The document id to be diffed
* @param {object} [options] - {keep:{}} Options to send to the diff endpoint
* the diff api outputs the changes between the input (branches or commits),
* the diff api outputs the changes between the input,
* but you can list the properties that you would like to see in the diff result in any case.
* @returns {Promise} A promise that returns the call response object, or an Error if rejected.
* @example
Expand Down Expand Up @@ -1640,7 +1640,7 @@ WOQLClient.prototype.apply = function (beforeVersion, afterVersion, message, mat
* @param {object} patch - The patch object
* @returns {Promise} A promise that returns the call response object, or an Error if rejected.
* @example
* let diffPatch = await client.getDiff(
* let diffPatch = await client.getJSONDiff(
* { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
* { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
* );
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@terminusdb/terminusdb-client",
"version": "10.0.17",
"version": "10.0.18",
"description": "TerminusDB client library",
"main": "index.js",
"types": "./dist/typescript/index.d.ts",
Expand Down