Skip to content

review typedef #234

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 2 commits into from
Oct 12, 2022
Merged

review typedef #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c5e795
review typedef
Francesca-Bit Oct 11, 2022
ff01db6
Apply docs changes
Francesca-Bit Oct 11, 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
6 changes: 2 additions & 4 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ graph all through a simple document API.
[terminusdb-docs]: https://terminusdb.com/docs/
[terminusdb-repo]: https://github.com/terminusdb/terminusdb

**TerminusX** is a self-service data platform that allows you to build, deploy,
execute, monitor, and share versioned data products. It is built on TerminusDB.
TerminusX is in public beta and you can [sign up now][dashboard].
**TerminusX** TerminusX is TerminusDB as a service. SOC 2 certified hosting. Build your beta and get to market fast. Scale up and deploy your own instance. [Sign up now][dashboard].

[dashboard]: https://dashboard.terminusdb.com/

Expand Down Expand Up @@ -71,7 +69,7 @@ it to your sources, and use that in the `<script>` instead.
This example creates a simple dataProduct, starting to create a database model the schema
and insert a simple document

For the [full Documentation][terminusdb-client-js-docs]
For the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/javascript-client-reference)

```javascript
const TerminusClient = require("@terminusdb/terminusdb-client");
Expand Down
7 changes: 6 additions & 1 deletion docs/_sidebar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- [server](api/woqlClient.js?id=server)
- [api](api/woqlClient.js?id=api)
- [organization](api/woqlClient.js?id=organization)
- [hasDatabase](api/woqlClient.js?id=hasDatabase)
- [getDatabases](api/woqlClient.js?id=getDatabases)
- [databases](api/woqlClient.js?id=databases)
- [user](api/woqlClient.js?id=user)
Expand Down Expand Up @@ -57,6 +58,7 @@
- [getEnums](api/woqlClient.js?id=getEnums)
- [getClassDocuments](api/woqlClient.js?id=getClassDocuments)
- [getBranches](api/woqlClient.js?id=getBranches)
- [getCommitsLog](api/woqlClient.js?id=getCommitsLog)
- [getPrefixes](api/woqlClient.js?id=getPrefixes)
- [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
- [userOrganizations](api/woqlClient.js?id=userOrganizations)
Expand All @@ -65,6 +67,8 @@
- [getVersionDiff](api/woqlClient.js?id=getVersionDiff)
- [apply](api/woqlClient.js?id=apply)
- [patch](api/woqlClient.js?id=patch)
- [sendCustomRequest](api/woqlClient.js?id=sendCustomRequest)
- [WOQLClient](api/woqlClient.js?id=WOQLClient)
- [WOQL](api/woql.js?id=WOQL)
- [using](api/woql.js?id=using)
- [comment](api/woql.js?id=comment)
Expand All @@ -91,7 +95,6 @@
- [put](api/woql.js?id=put)
- [as](api/woql.js?id=as)
- [remote](api/woql.js?id=remote)
- [file](api/woql.js?id=file)
- [post](api/woql.js?id=post)
- [delete_triple](api/woql.js?id=delete_triple)
- [delete_quad](api/woql.js?id=delete_quad)
Expand Down Expand Up @@ -153,6 +156,7 @@
- [vars](api/woql.js?id=vars)
- [doc](api/woql.js?id=doc)
- [client](api/woql.js?id=client)
- [Vars](api/woql.js?id=Vars)
- [emerge](api/woql.js?id=emerge)
- [update_triple](api/woql.js?id=update_triple)
- [update_quad](api/woql.js?id=update_quad)
Expand Down Expand Up @@ -211,6 +215,7 @@
- [ActionType](api/typedef.js?id=ActionType)
- [ParamsObj](api/typedef.js?id=ParamsObj)
- [RolesObj](api/typedef.js?id=RolesObj)
- [ResourceType](api/typedef.js?id=ResourceType)
- [RepoType](api/typedef.js?id=RepoType)
- [DbDetails](api/typedef.js?id=DbDetails)
- [RemoteRepoDetails](api/typedef.js?id=RemoteRepoDetails)
Expand Down
4 changes: 2 additions & 2 deletions docs/api/accesscontrol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ accessControl.deleteUser(userId).then(result=>{
```

## manageCapability
##### accessControl.manageCapability(userName, resourceName, rolesArr, operation, resourceType) ⇒ <code>Promise</code>
##### accessControl.manageCapability(userName, resourceName, rolesArr, operation, scopeType) ⇒ <code>Promise</code>
-- TerminusdDB API ---
Grant/Revoke Capability

Expand All @@ -254,7 +254,7 @@ Grant/Revoke Capability
| resourceName | <code>string</code> | the name of a (database or team) |
| rolesArr | <code>array</code> | the roles name list |
| operation | <code>typedef.CapabilityCommand</code> | grant/revoke operation |
| resourceType | <code>typedef.ResourceType</code> | the resource type (database or organization) |
| scopeType | <code>typedef.ScopeType</code> | the resource type (database or organization) |

**Example**
```javascript
Expand Down
5 changes: 3 additions & 2 deletions docs/api/typedef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ the GET document interface query parameters

| Name | Type | Description |
| --- | --- | --- |
| [query] | <code>object</code> | object that descrive the document query |
| [graph_type] | <code>GraphType</code> | instance|schema, default value is instance. Used to switch between getting documents from the instance or the schema graph. |
| [type] | <code>string</code> | only documents of the given type are returned. |
| [id] | <code>string</code> | only the document with the given ID is returned. |
Expand Down Expand Up @@ -131,8 +132,8 @@ the DELETE document interface query parameters
| [invitation] | <code>string</code> | - |


## ResourceType
##### ResourceType: ` "database"` | ` "organization" `
## ScopeType
##### ScopeType: ` "database"` | ` "organization" `

## RepoType
##### RepoType: ` "local"` | ` "remote" `
Expand Down
Loading