Skip to content

Commit bfde60b

Browse files
Francesca-BitFrancesca-Bit
committed
review the docs
1 parent 22c4d7e commit bfde60b

20 files changed

+909
-656
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# terminusdb-client
1+
# TerminusDB-Client
22

33
[![build status](https://api.travis-ci.com/terminusdb/terminusdb-client.svg?branch=master)](https://travis-ci.com/terminusdb/terminusdb-client)
44
[![Coverage Status](https://coveralls.io/repos/github/terminusdb/terminusdb-client/badge.svg?branch=master)](https://coveralls.io/repos/github/terminusdb/terminusdb-client/badge.svg?branch=master)

‎docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# terminusdb-client
1+
# TerminusDB-Client
22

33
[![build status](https://api.travis-ci.com/terminusdb/terminusdb-client.svg?branch=master)](https://travis-ci.com/terminusdb/terminusdb-client)
44
[![Coverage Status](https://coveralls.io/repos/github/terminusdb/terminusdb-client/badge.svg?branch=master)](https://coveralls.io/repos/github/terminusdb/terminusdb-client/badge.svg?branch=master)

‎docs/api/navtest.js.md

Lines changed: 76 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,79 @@
1+
- [Getting started](README.md)
2+
- [Requirements](README?id=requirements)
3+
- [Installation](README?id=installation)
4+
- [NPM Module](README?id=npm-module)
5+
- [Minified Script](README?id=minified-script)
6+
- [Usage](README?id=usage)
7+
- [Report Issues](README?id=report-issues)
8+
- [Contribute](README?id=contribute)
9+
- [Licence](README?id=licence)
110
- [WOQLClient](api/woqlClient.js?id=WOQLClient)
2-
- [copy](api/woqlClient.js?id=copy)
3-
- [server](api/woqlClient.js?id=server)
4-
- [api](api/woqlClient.js?id=api)
5-
- [organization](api/woqlClient.js?id=organization)
6-
- [user](api/woqlClient.js?id=user)
7-
- [uid](api/woqlClient.js?id=uid)
8-
- [userOrganization](api/woqlClient.js?id=userOrganization)
9-
- [databases](api/woqlClient.js?id=databases)
10-
- [databaseInfo](api/woqlClient.js?id=databaseInfo)
11-
- [db](api/woqlClient.js?id=db)
12-
- [setSystemDb](api/woqlClient.js?id=setSystemDb)
13-
- [repo](api/woqlClient.js?id=repo)
14-
- [checkout](api/woqlClient.js?id=checkout)
15-
- [ref](api/woqlClient.js?id=ref)
16-
- [localAuth](api/woqlClient.js?id=localAuth)
17-
- [remoteAuth](api/woqlClient.js?id=remoteAuth)
18-
- [author](api/woqlClient.js?id=author)
19-
- [set](api/woqlClient.js?id=set)
20-
- [resource](api/woqlClient.js?id=resource)
21-
- [connect](api/woqlClient.js?id=connect)
22-
- [createDatabase](api/woqlClient.js?id=createDatabase)
23-
- [deleteDatabase](api/woqlClient.js?id=deleteDatabase)
24-
- [createGraph](api/woqlClient.js?id=createGraph)
25-
- [deleteGraph](api/woqlClient.js?id=deleteGraph)
26-
- [getTriples](api/woqlClient.js?id=getTriples)
27-
- [updateTriples](api/woqlClient.js?id=updateTriples)
28-
- [insertTriples](api/woqlClient.js?id=insertTriples)
29-
- [insertCSV](api/woqlClient.js?id=insertCSV)
30-
- [updateCSV](api/woqlClient.js?id=updateCSV)
31-
- [getCSV](api/woqlClient.js?id=getCSV)
32-
- [deleteCSV](api/woqlClient.js?id=deleteCSV)
33-
- [message](api/woqlClient.js?id=message)
34-
- [action](api/woqlClient.js?id=action)
35-
- [info](api/woqlClient.js?id=info)
36-
- [query](api/woqlClient.js?id=query)
37-
- [branch](api/woqlClient.js?id=branch)
38-
- [squashBranch](api/woqlClient.js?id=squashBranch)
39-
- [resetBranch](api/woqlClient.js?id=resetBranch)
40-
- [optimizeBranch](api/woqlClient.js?id=optimizeBranch)
41-
- [deleteBranch](api/woqlClient.js?id=deleteBranch)
42-
- [pull](api/woqlClient.js?id=pull)
43-
- [fetch](api/woqlClient.js?id=fetch)
44-
- [push](api/woqlClient.js?id=push)
45-
- [rebase](api/woqlClient.js?id=rebase)
46-
- [reset](api/woqlClient.js?id=reset)
47-
- [clonedb](api/woqlClient.js?id=clonedb)
48-
- [dispatch](api/woqlClient.js?id=dispatch)
49-
- [generateCommitInfo](api/woqlClient.js?id=generateCommitInfo)
50-
- [generateCommitDescriptor](api/woqlClient.js?id=generateCommitDescriptor)
51-
- [prepareRevisionControlArgs](api/woqlClient.js?id=prepareRevisionControlArgs)
52-
- [_load_db_prefixes](api/woqlClient.js?id=_load_db_prefixes)
53-
- [getClassFrame](api/woqlClient.js?id=getClassFrame)
54-
- [updateDatabase](api/woqlClient.js?id=updateDatabase)
55-
- [organizations](api/woqlClient.js?id=organizations)
56-
- [action_permitted](api/woqlClient.js?id=action_permitted)
57-
- [createUser](api/woqlClient.js?id=createUser)
58-
- [getUser](api/woqlClient.js?id=getUser)
59-
- [updateUser](api/woqlClient.js?id=updateUser)
60-
- [deleteUser](api/woqlClient.js?id=deleteUser)
61-
- [createOrganization](api/woqlClient.js?id=createOrganization)
62-
- [getOrganization](api/woqlClient.js?id=getOrganization)
63-
- [updateOrganization](api/woqlClient.js?id=updateOrganization)
64-
- [deleteOrganization](api/woqlClient.js?id=deleteOrganization)
65-
- [getRoles](api/woqlClient.js?id=getRoles)
66-
- [updateRoles](api/woqlClient.js?id=updateRoles)
11+
- [TerminusDB Client API](api/woqlClient.js?id=terminusdb-client-api)
12+
- [Connect](api/woqlClient.js?id=connect)
13+
- [Create Database](api/woqlClient.js?id=create-database)
14+
- [Delete Database](api/woqlClient.js?id=delete-database)
15+
- [Create Graph](api/woqlClient.js?id=create-graph)
16+
- [Delete Graph](api/woqlClient.js?id=delete-graph)
17+
- [Get Triples](api/woqlClient.js?id=get-triples)
18+
- [Update Triples](api/woqlClient.js?id=update-triples)
19+
- [Query](api/woqlClient.js?id=query)
20+
- [Clonedb](api/woqlClient.js?id=clonedb)
21+
- [Branch](api/woqlClient.js?id=branch)
22+
- [Rebase](api/woqlClient.js?id=rebase)
23+
- [Pull](api/woqlClient.js?id=pull)
24+
- [Push](api/woqlClient.js?id=push)
25+
- [Fetch](api/woqlClient.js?id=fetch)
26+
- [Insert CSV](api/woqlClient.js?id=insert-csv)
27+
- [Update CSV](api/woqlClient.js?id=update-csv)
28+
- [Get CSV](api/woqlClient.js?id=get-csv)
29+
- [Delete CSV](api/woqlClient.js?id=delete-csv)
30+
- [copy](api/woqlClient.js?id=copy)
31+
- [server](api/woqlClient.js?id=server)
32+
- [api](api/woqlClient.js?id=api)
33+
- [organization](api/woqlClient.js?id=organization)
34+
- [user](api/woqlClient.js?id=user)
35+
- [uid](api/woqlClient.js?id=uid)
36+
- [userOrganization](api/woqlClient.js?id=userOrganization)
37+
- [databases](api/woqlClient.js?id=databases)
38+
- [databaseInfo](api/woqlClient.js?id=databaseInfo)
39+
- [db](api/woqlClient.js?id=db)
40+
- [setSystemDb](api/woqlClient.js?id=setSystemDb)
41+
- [repo](api/woqlClient.js?id=repo)
42+
- [checkout](api/woqlClient.js?id=checkout)
43+
- [ref](api/woqlClient.js?id=ref)
44+
- [localAuth](api/woqlClient.js?id=localAuth)
45+
- [remoteAuth](api/woqlClient.js?id=remoteAuth)
46+
- [author](api/woqlClient.js?id=author)
47+
- [set](api/woqlClient.js?id=set)
48+
- [resource](api/woqlClient.js?id=resource)
49+
- [insertTriples](api/woqlClient.js?id=insertTriples)
50+
- [message](api/woqlClient.js?id=message)
51+
- [action](api/woqlClient.js?id=action)
52+
- [info](api/woqlClient.js?id=info)
53+
- [squashBranch](api/woqlClient.js?id=squashBranch)
54+
- [resetBranch](api/woqlClient.js?id=resetBranch)
55+
- [optimizeBranch](api/woqlClient.js?id=optimizeBranch)
56+
- [deleteBranch](api/woqlClient.js?id=deleteBranch)
57+
- [reset](api/woqlClient.js?id=reset)
58+
- [dispatch](api/woqlClient.js?id=dispatch)
59+
- [generateCommitInfo](api/woqlClient.js?id=generateCommitInfo)
60+
- [generateCommitDescriptor](api/woqlClient.js?id=generateCommitDescriptor)
61+
- [prepareRevisionControlArgs](api/woqlClient.js?id=prepareRevisionControlArgs)
62+
- [_load_db_prefixes](api/woqlClient.js?id=_load_db_prefixes)
63+
- [getClassFrame](api/woqlClient.js?id=getClassFrame)
64+
- [updateDatabase](api/woqlClient.js?id=updateDatabase)
65+
- [organizations](api/woqlClient.js?id=organizations)
66+
- [action_permitted](api/woqlClient.js?id=action_permitted)
67+
- [createUser](api/woqlClient.js?id=createUser)
68+
- [getUser](api/woqlClient.js?id=getUser)
69+
- [updateUser](api/woqlClient.js?id=updateUser)
70+
- [deleteUser](api/woqlClient.js?id=deleteUser)
71+
- [createOrganization](api/woqlClient.js?id=createOrganization)
72+
- [getOrganization](api/woqlClient.js?id=getOrganization)
73+
- [updateOrganization](api/woqlClient.js?id=updateOrganization)
74+
- [deleteOrganization](api/woqlClient.js?id=deleteOrganization)
75+
- [getRoles](api/woqlClient.js?id=getRoles)
76+
- [updateRoles](api/woqlClient.js?id=updateRoles)
6777
- [WOQL](api/woql.js?id=WOQL)
6878
- [eval](api/woql.js?id=eval)
6979
- [using](api/woql.js?id=using)
@@ -186,3 +196,4 @@
186196
- [DbDetails](api/typedef.js?id=DbDetails)
187197
- [RemoteRepoDetails](api/typedef.js?id=RemoteRepoDetails)
188198
- [CloneSourceDetails](api/typedef.js?id=CloneSourceDetails)
199+

‎docs/api/typedef.js.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,9 @@
3939

4040

4141
## GraphRef
42-
4342
#### GraphRef : <code>&quot;schema/main&quot;</code> \| <code>&quot;schema/\*&quot;</code> \| <code>&quot;instance/main&quot;</code> \| <code>&quot;instance/\*&quot;</code> \| <code>&quot;inference/main&quot;</code> \| <code>&quot;inference/\*&quot;</code> \| <code>string</code>
4443

4544
## DataFormatObj
46-
4745
#### DataFormatObj : <code>Object</code>
4846
(export/import)
4947

@@ -56,11 +54,9 @@
5654

5755

5856
## FuntionType
59-
6057
#### FuntionType : <code>&quot;add\_quad&quot;</code> \| <code>&quot;delete\_quad&quot;</code> \| <code>&quot;add\_triple&quot;</code> \| <code>&quot;delete\_triple&quot;</code> \| <code>&quot;quad&quot;</code> \| <code>&quot;triple&quot;</code>
6158

6259
## ClassObj
63-
6460
#### ClassObj : <code>Object</code>
6561
the class details object
6662

@@ -77,7 +73,6 @@ the class details object
7773

7874

7975
## PropertyObj
80-
8176
#### PropertyObj : <code>Object</code>
8277
an object that describe a property element
8378

@@ -96,15 +91,12 @@ an object that describe a property element
9691

9792

9893
## ResourceType
99-
10094
#### ResourceType : <code>&quot;commits&quot;</code> \| <code>&quot;meta&quot;</code> \| <code>&quot;branch&quot;</code> \| <code>&quot;ref&quot;</code> \| <code>&quot;repo&quot;</code> \| <code>&quot;db&quot;</code>
10195

10296
## GraphType
103-
10497
#### GraphType : <code>&quot;inference&quot;</code> \| <code>&quot;schema&quot;</code> \| <code>&quot;instance&quot;</code>
10598

10699
## CredentialObj
107-
108100
#### CredentialObj : <code>Object</code>
109101
**Properties**
110102

@@ -116,11 +108,9 @@ an object that describe a property element
116108

117109

118110
## ActionType
119-
120111
#### ActionType : <code>&#x27;graph&#x27;</code> \| <code>&#x27;db&#x27;</code> \| <code>&#x27;clone&#x27;</code> \| <code>&#x27;triples&#x27;</code> \| <code>&#x27;woql&#x27;</code> \| <code>&#x27;frame&#x27;</code> \| <code>&#x27;fetch&#x27;</code> \| <code>&#x27;pull&#x27;</code> \| <code>&#x27;rebase&#x27;</code> \| <code>&#x27;csv&#x27;</code> \| <code>&#x27;branch&#x27;</code> \| <code>&#x27;reset&#x27;</code> \| <code>&#x27;push&#x27;</code> \| <code>&#x27;squash&#x27;</code>
121112

122113
## ParamsObj
123-
124114
#### ParamsObj : <code>Object</code>
125115
**Properties**
126116

@@ -139,7 +129,6 @@ an object that describe a property element
139129

140130

141131
## RolesObj
142-
143132
#### RolesObj : <code>Object</code>
144133
**Properties**
145134

@@ -153,11 +142,9 @@ an object that describe a property element
153142

154143

155144
## RepoType
156-
157145
#### RepoType : <code>&quot;local&quot;</code> \| <code>&quot;remote&quot;</code>
158146

159147
## DbDetails
160-
161148
#### DbDetails : <code>Object</code>
162149
**Properties**
163150

@@ -174,7 +161,6 @@ an object that describe a property element
174161

175162

176163
## RemoteRepoDetails
177-
178164
#### RemoteRepoDetails : <code>Object</code>
179165
{remote: "origin", "remote_branch": "main", "author": "admin", "message": "message"}
180166

@@ -189,7 +175,6 @@ an object that describe a property element
189175

190176

191177
## CloneSourceDetails
192-
193178
#### CloneSourceDetails : <code>Object</code>
194179
**Properties**
195180

0 commit comments

Comments
 (0)