Skip to content

Commit d5fca2f

Browse files
Francesca-Bitgithub-actions[bot]
authored andcommitted
Apply docs changes
1 parent d7f7f35 commit d5fca2f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/api/woqlclient.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1132,7 +1132,7 @@ Get the patch of difference between two documents.
11321132
| --- | --- | --- |
11331133
| before | <code>object</code> | The current state of JSON document |
11341134
| after | <code>object</code> | The updated state of JSON document |
1135-
| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint the diff api outputs the changes between the input (JSON Object), but you can list the properties that you would like to see in the diff result in any case. |
1135+
| [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. |
11361136
11371137
**Example**
11381138
```javascript
@@ -1178,9 +1178,9 @@ Get the patch of difference between branches or commits.
11781178
| Param | Type | Description |
11791179
| --- | --- | --- |
11801180
| beforeVersion | <code>string</code> | Before branch/commit to compare |
1181-
| afterVersion | <code>string</code> | Before branch/commit to compare |
1182-
| [id] | <code>string</code> | The object id to be diffed, if it is omitted all the documents will be compared |
1183-
| [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. |
1181+
| afterVersion | <code>string</code> | After branch/commit to compare |
1182+
| [id] | <code>string</code> | The document id to be diffed, if it is omitted all the documents will be compared |
1183+
| [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. |
11841184
11851185
**Example**
11861186
```javascript
@@ -1211,22 +1211,22 @@ client.getVersionDiff("main","mybranch",options).then(diffResult=>{
12111211
12121212
## apply
12131213
##### woqlClient.apply(beforeVersion, afterVersion, message, [match_final_state], [options])
1214-
Diff two different commits and apply changes on the current branch/commit
1215-
if you would like to change branch or commit before apply use client.checkout("branchName")
1214+
Diff two different commits and apply changes on the current branch/commit.
1215+
If you would like to change branch or commit before apply use client.checkout("branchName")
12161216
12171217
12181218
| Param | Type | Description |
12191219
| --- | --- | --- |
12201220
| beforeVersion | <code>string</code> | Before branch/commit to compare |
1221-
| afterVersion | <code>string</code> | Before branch/commit to compare |
1221+
| afterVersion | <code>string</code> | After branch/commit to compare |
12221222
| message | <code>string</code> | apply commit message |
1223-
| [match_final_state] | <code>boolean</code> | the deafult value is false |
1223+
| [match_final_state] | <code>boolean</code> | the default value is false |
12241224
| [options] | <code>object</code> | {keep:{}} Options to send to the apply endpoint |
12251225
12261226
**Example**
12271227
```javascript
12281228
client.checkout("mybranch")
1229-
client.apply("main","mybranch").then(result=>{
1229+
client.apply("main","mybranch","merge main").then(result=>{
12301230
console.log(result)
12311231
})
12321232
```

0 commit comments

Comments
 (0)