Skip to content

Commit fc41248

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

File tree

3 files changed

+18
-4
lines changed

3 files changed

+18
-4
lines changed

docs/api/accesscontrol.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
**License**: Apache Version 2
55

66
## new AccessControl()
7-
The AccessControl object has various methods to control the access for users.
8-
for the credential you can use the JWT token or the API token
7+
The AccessControl is a driver to work with
8+
TerminusDB and TerminusX access control api
9+
for the credential you can use the JWT token, the API token or
10+
the basic authentication with username and password
911

1012
**Example**
1113
```javascript
@@ -92,6 +94,16 @@ Get a API url from cloudAPIUrl
9294
| cloudAPIUrl | <code>string</code> | The base url for cloud |
9395

9496

97+
## customHeaders
98+
##### accessControl.customHeaders(customHeaders) ⇒ <code>object</code>
99+
add extra headers to your request
100+
101+
102+
| Param | Type |
103+
| --- | --- |
104+
| customHeaders | <code>object</code> |
105+
106+
95107
## getAllOrganizations
96108
##### accessControl.getAllOrganizations() ⇒ <code>Promise</code>
97109
-- TerminusDB API ---

docs/api/typedef.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ the POST document interface query parameters
3232

3333
| Name | Type | Description |
3434
| --- | --- | --- |
35+
| [raw_json] | <code>boolean</code> | default is false, If true, the input documents are treated as raw JSON, inserted as type sys:JSONDocument and are not subject to schema restrictions. |
3536
| [graph_type] | <code>GraphType</code> | default is instance instance|schema Used to switch between getting documents from the instance or the schema graph. |
3637
| [full_replace] | <code>boolean</code> | default is false, If true, all existing documents are deleted before inserting the posted documents. This allows the full replacement of the contents of a database. This is especially useful for replacing the schema. |
3738

@@ -44,6 +45,7 @@ the PUT document interface query parameters
4445

4546
| Name | Type | Description |
4647
| --- | --- | --- |
48+
| [raw_json] | <code>boolean</code> | default is false, If true, the input documents are treated as raw JSON, inserted as type sys:JSONDocument and are not subject to schema restrictions. |
4749
| [graph_type] | <code>GraphType</code> | default is instance, instance|schema Used to switch between getting documents from the instance or the schema graph. |
4850

4951

docs/api/woqlclient.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@ and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error
699699
| Param | Type | Description |
700700
| --- | --- | --- |
701701
| json | <code>object</code> | |
702-
| [params] | <code>typedef.DocParamsPost</code> | the post parameters |
702+
| [params] | <code>typedef.DocParamsPost</code> | the post parameters [#typedef.DocParamsPost](#typedef.DocParamsPost) |
703703
| [dbId] | <code>string</code> | the dbid |
704704
| [string] | <code>message</code> | the insert commit message |
705705
| [lastDataVersion] | <code>string</code> | the last data version tracking id. |
@@ -866,7 +866,7 @@ and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error
866866
| Param | Type | Description |
867867
| --- | --- | --- |
868868
| json | <code>object</code> | |
869-
| [params] | <code>typedef.DocParamsPut</code> | the Put parameters |
869+
| [params] | <code>typedef.DocParamsPut</code> | the Put parameters [#typedef.DocParamsPut](#typedef.DocParamsPut) |
870870
| [dbId] | <code>\*</code> | the database id |
871871
| [message] | <code>\*</code> | the update commit message |
872872
| [lastDataVersion] | <code>string</code> | the last data version tracking id. |

0 commit comments

Comments
 (0)