Skip to content

Commit 645e116

Browse files
committed
review docs
1 parent a237e87 commit 645e116

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

docs/_sidebar.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
- [Pull](api/woqlClient.js?id=pull)
1414
- [Push](api/woqlClient.js?id=push)
1515
- [Fetch](api/woqlClient.js?id=fetch)
16+
- [setApiKey](api/woqlClient.js?id=setApiKey)
1617
- [customHeaders](api/woqlClient.js?id=customHeaders)
18+
- [setApiKey](api/woqlClient.js?id=setApiKey)
1719
- [copy](api/woqlClient.js?id=copy)
1820
- [server](api/woqlClient.js?id=server)
1921
- [api](api/woqlClient.js?id=api)
@@ -156,7 +158,6 @@
156158
- [update_quad](api/woql.js?id=update_quad)
157159
- [value](api/woql.js?id=value)
158160
- [link](api/woql.js?id=link)
159-
- [libs](api/woql.js?id=libs)
160161
- [DocParamsGet](api/typedef.js?id=DocParamsGet)
161162
- [DocParamsPost](api/typedef.js?id=DocParamsPost)
162163
- [DocParamsPut](api/typedef.js?id=DocParamsPut)

docs/api/woql.js.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,6 +1217,9 @@ const query = WOQL.lib().previousCommits('m8vpxewh2aovfauebfkbzwmj4qwr5lb')
12171217
//return the commits of a specific branch starting from the head
12181218
//if a timestamp is given, gets the commits before the specified timestamp
12191219
const query = WOQL.lib().commits('main',10,1630683082.9278786)
1220+
1221+
//return the branches list with the timestamp and commits id
1222+
const query = WOQL.lib().branches()
12201223
```
12211224

12221225
### string

docs/api/woqlClient.js.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,14 @@ Use [#localAuth](#localAuth) instead.
248248
Use [#remoteAuth](#remoteAuth) instead.
249249
250250
251+
### setApiKey
252+
#### woqlClient.setApiKey(accessToken)
253+
254+
| Param | Type |
255+
| --- | --- |
256+
| accessToken | <code>string</code> |
257+
258+
251259
### customHeaders
252260
#### woqlClient.customHeaders(customHeaders) ⇒ <code>object</code>
253261
add extra headers to your request
@@ -258,6 +266,16 @@ add extra headers to your request
258266
| customHeaders | <code>object</code> |
259267
260268
269+
### setApiKey
270+
#### woqlClient.setApiKey(accessToken)
271+
set the api access token to connect to TerminusX Cloud
272+
273+
274+
| Param | Type |
275+
| --- | --- |
276+
| accessToken | <code>string</code> |
277+
278+
261279
### copy
262280
#### woqlClient.copy() ⇒ [<code>WOQLClient</code>](#WOQLClient)
263281
creates a copy of the client with identical internal state and context

0 commit comments

Comments
 (0)